Gswiki:Style guide/Item scripts

Item script pages are articles displaying information about scripted items within GemStone IV.

In order to streamline the process for creating and editing item script pages on the Wiki, an item script form is available with instructions and easy input for parameters.

Overview

Below is a breakdown of templates used and a list of sections and what goes in them. This is primarily a point of reference for those who wish to manually edit an item script page, however the item script form handles this information automatically within it.

Templates Used

• Template:ItemScriptInfo: This template is used to create a sidebar table for quick at-a-glance information regarding the item script, verbs used, and populates an introductory paragraph based on certain parameters within the template. This should always appear at the top of the article when creating or editing.
• Template:VerbTableStart: This template is used to create a table header to record verb and loresong messaging.
• Template:VerbTableEntry: This template is used to add entries to the table created by VerbTableStart.
• Template:Table end: This is a simple template to indicate the end of a table.

Sections

Analyze

This section if for the script's ANALYZE. If available, the full, unlocked analyze should be entered. Otherwise, the highest tier available should be entered for reference. When entering, please surround text with <pre{{log2}}></pre>, ex. <pre{{log2}}>(Input from analyze information)</pre>. Please note: Not all item scripts will have an ANALYZE available.

Usage Information

This section is for the script's tiering (if any) and verb usage information, and may include a small blurb regarding what the tier upgrade offers, such as an update to mechanical information. It should be used for to create tables showcasing the item's 1P/2P/3P messaging.

• Single Tier Items

For items that do not have tiers to unlock, all that is needed in this section is the verb usage tables (instructions/template code below).

• Multiple Tier Items

For items with 2 or more tiers (this includes items that are simply "locked" or "unlocked"), tiers should be broken down by level 3 subheaders, ex. ===Tier 1===. Besides verbs, some items may have additional abilities unlocked per tier, which should be detailed in a short blurb following the tier subheader. Following that should be the verb usage tables (instructions/template code below), if that tier provides additional verb usage.

Verb Table Copy/Paste Code

Messaging output should be displayed utilizing a table. For ease of use, the below copy and paste codes present an idea as to how to utilize the templates to build the table, however because scripts may vary considerably, there is no set way to create a table to work in all instances.

For the VerbTableEntry template

Modifier and 2Pview cells will not populate unless there is an entry in them. This is to ensure the cells line up properly. If utilizing header1,header2, header3, or 2Pview in VerbTableStart, the applicable cells must have something entered to indicate if it is not applicable, such as a dash, or N/A.

• Untargeted

{{VerbTableStart |header1= Verb |header2=  |header3=  }}
{{VerbTableEntry|modifier1= VERB |modifier2= |modifier3= |1Pview=  |3Pview=  }}
{{Table end}}

• Targeted

{{VerbTableStart |header1= Verb |header2= Target |header3=  |2Pview= Yes}}
{{VerbTableEntry|modifier1= VERB |modifier2= Target |modifier3=  |1Pview=  |2Pview= {{addmetext}} |3Pview=  }}
{{Table end}}

Mechanics Information

This section is specifically for mechanical flourishes/scripts in order to list mechanical information, in detail. This would includes logs of use to provide examples of the item in action.

Additional Information

This section is for additional script information not covered in the templateabove templates, including, but not limited to, if an item has a hard-coded LOOK/SHOW, mechanics details and messaging (attack/defense messaging, etc), etc. In the form, this section will populate if left empty, however as a level 2 subheader, it will have the following sections (Restrictions, Look/Show, Read), if filled in, fall under it. If left empty, and the other listed subheaders are left empty, it may be removed by editing the page after the page is saved from the form.

Restrictions

This section is to list any restrictions the item script may have in place. This may include, but is not limited to, whether it can be lightened or deepened, alteration restrictions, etc.

Look/Show

This section is to display if an item has a hard-coded look/show to it.

Read

This section is to display if an item has a hard-coded read to it. This section will not populate if left empty.

Loresong

This section is to display if an item has a loresong associated with the script.

Table Entry

To enter the loresong and verses, please utilize the below table code/example:

{{VerbTableStart |header1= Verse }}
{{VerbTableEntry|modifier1= Verse # |modifier2= |1Pview=  |3Pview=  }}
{{Table end}}

Ambient Messaging

This section is to display if an item has ambient associated with the script. When entering, please surround text with <pre{{log2}}></pre>, ex. <pre{{log2}}>(Input from analyze information)</pre>. Ambient messaging should indicate 1P vs. 3P, if possible, either by labeling it as such, or utilizing italics for one and plain text for the other.

See Also

This section is for internal links that correspond with or complement the article, particularly similar item scripts to this.

Resources

This section is for external links that correspond with or complement the article.

References

This section if for internal or external citations (utilizing <ref></ref>) if used regarding the article.

Article Creation

The below section goes over template parameters and their use, including within the item script form.

Due to the update in templates and the addition of the item script form, articles should be limited to a single item type, primarily if the analyze varies. Items that have related scripts (formerly corresponding scripts or a script family) should be listing and linked on a main (or landing) page, ex. Mount. The main page does not need to use the templates specifically listed on this page, so long as a table or list is provided on the main page to ensure each individual item script is properly linked to it. Only the individual item pages should follow the guidelines and templating parameters listed on this page. Items that have script variations, ex. Book Buddies, should still remain on a single item script page.

Article Name

Scripted items will often have a "script name" found in the item's ANALYZE. This can be a proper name or a generic name, and applicable casing should be considered in the article title. The article name is reflected in the introductory paragraph that is automatically populated by the entries noted below.

For items that do not have an analyze or do not have a generic name within the analyze, please set the name to what would closest reflect the general concept of the item script.

Propername

The propername parameter of the template is used to handle "generic names" of item scripts and will force the article name to become lowercase in the introductory paragraph. If the article/script name is the proper name of the item, "yes" will need to be entered into the template or selected in the form. If it is not, "no" will need to be entered into the template or selected in the form. This is a mandatory field.

Flourishes

Flourishes are stand-alone scripts that can be applied to items in addition to the script and subscript slots. Each item can have up to 20 Flourishes.

There are two types of Flourishes: combat and fluff.

A combat flourish is a flourish script that has mechanical benefit. Only one combat flourish can be active at a time by default, but which is active can be changed via the FLOURISH verb when not in combat. If multiple mechanical flourishes are applied to one item, the project difficulty will be increased based on the highest difficulty out of all applied flourishes, regardless of which is currently active.

Flourish priority also determines which script's verb traps will fire, if multiple Flourishes trap the same verb.

Itemscript

The itemscript parameter of the template is used to indicate if a script is just a script, a flourish, or both. If utilizing the template directly, this would be entered as "script", "flourish", or if both, "flourish,script", specifically with a comma and no spaces to separate them. In the form, this is a checkbox to check all that apply. This is a mandatory field, and corresponds with the Item script property.

Categories

Categories, in regards to item scripts, are used to determine the overall type of script it is. As it will always be at least one of the below listed categories, it is a mandatory field and corresponds with the item script category property.

Please note: An item will either be mechanical (ie. it provides the user with a mechanical benefit) or fluff (ie. it is meant for roleplay and provides no mechanical benefit). Items that are mechanical in nature may have fluff scripts associated with them, but fluff items do not grant a mechanical benefit at all. If an item provides a mechanical benefit off-the-shell, it will always be categorized as mechanical, not fluff, regardless of the fluff scripts associated with it. In rare cases, an item will fall into both categories, but this may only occur if the item is purely fluff up until a certain unlock in which it provides a mechanical benefit to the user.

• Fluff: These types of scripts do not provide a mechanical benefit to the user, even though they may be added to things that do, such as weapons or armor. Examples include: Fuzzy Warm Parkas, Veola hair accessories, Peretta gowns.
• Mechanical: Formally known as "functional" item scripts. These scripts provide a mechanical benefit to the user. Examples include: Mana-Infused Armor, Sigil Staff, and Sprite Weapon.
• Mount: These types of script apply specifically to mount items. They can be either fluff or mechanical, and sometimes both.
• Private property: These types of scripts apply specifically to private property items. They can be either fluff or mechanical, and sometimes both.

Classification

Classifications refer to what the item script can apply to. As these are meant to be umbrella terms, if the item script is specific to a noun type within the classifications, that should be noted with restrictions.

• Accessory: These scripts apply to accessory items only. Applicable worn locations (based on INVENTORY) are: pin-worn, waist-worn (worn as a belt, not belt-worn), head-worn, wrist-worn, finger-worn, feet-worn*, neck-worn*, arm-worn, leg-worn (attached to), ear(s)-worn, ankle-worn, front-worn*, hands-worn, feet-worn (worn as socks, slipped on), hair-worn, leggings-worn (slipped into)*. Examples include Nexus jewelry, Knee-high stockings, Veola hair accessory.
• Armor: These scripts apply solely to armor.
• Clothing: These scripts apply to clothing items. Applicable worn locations (based on INVENTORY) are: shoulders-worn/draped over shoulders (also known as cloak-worn), shoulder-worn (slung over)*, front-worn*, chest-worn, under-chest-worn (layered), leg-worn (pulled over), leggings-worn (slipped into)*, & feet-worn* (shoes). Examples include: Dramatic Drapery (shoulders-worn/cloak-worn), Yansio clothing, Peretta gowns.
• Container: These scripts apply to containers, such as belt-worn, back-worn, front-worn*, neck-worn*, or shoulder-worn (slung over)* items. For the purpose of this classification, it does not include cloak-worn items.
• Miscellaneous: These scripts apply to items that do not fall within the aforementioned categories. Examples include: gemcutters, lapidary boxes.
• Shield: These scripts apply to shields.
• Weapon: These scripts apply solely to weapons.

*Please note: Certain worn locations may have overlap in categories based on the particular noun they use. For instance, a front-worn corset would fall under the clothing category, a front-worn harness or bandolier would fall under containers, and a front-worn piece of jewelry would fall under accessories.

Class

The class parameter of the template is used to indicate which of the classes listed above the script pertains to. If utilizing the template directly, this would be entered as "accessory", "armor", or if multiple, "accessory,armor...", specifically with a comma and no spaces to separate them. In the form, these are multiple checkboxes to check all that apply. This field corresponds with the Item script classification property.

Type

Type refers to a subcategory of items that does not apply to specifically to classification or has abilities that coincide with classifications but cannot fall directly beneath what is listed.

• Cooking: These scripts are used in the cooking system.
• Crafting: These scripts are used in the various crafting systems.
• Creature: These scripts apply to creature-type items, such as pets, ex. Dhu kittens or Mounts.
• Feature altering: These scripts can alter one's features.
• Glamour: These scripts can apply a glamour in various spots, ex. Illusion props.
• Storage: These scripts apply primarily to containers and allow for stacked storage, often weightlessly, within them, ex. Perfuminator or Bag of Holding.
• Vissi: These scripts apply strictly to vissi within the Vissi system.

If utilizing the template directly, this would be entered as "cooking", "crafting", or if multiple, "cooking,crafting...", specifically with a comma and no spaces to separate them. In the form, these are checkboxes to check all that apply. This field corresponds with the Item script type property.

Tiering

Some item scripts are basic with only have a single tier and minimal interaction. Others require unlocks in order to get full usage from them.

Tiers

The tiers parameter of the template should only be filled in with the amount of tiers an item has if more than one. In the form, this appears as "Max Tier Count". This field corresponds with the Item script tiers property.

Unlocks

The unlocks parameter of the template is used to note how to unlock an item script to the next tier. In the form, this appears as "Unlock Type". This field is corresponds with the Item script unlock property.

• Bundling: Bundling unlocks refers to whether you can BUNDLE or ADD one item to another to unlock it further, such as vissi within the vissi system.
• Certificate: Certificates sold off the shelf can be used to unlock item scripts to the next tier.
• Merchant: This unlock type is if a special merchant can unlock the item script to the next tier.
• Premium Unlocker: As a premium benefit, certain scripts may be able to be unlocked 1x per account per month at the Premium Unlocker on Mist Harbor. Not all tiers are available for this unlock option.
• Quest: Some item scripts can only be unlocked by participating in and completing a quest.

Customization Facets

The customization parameter of the template is used to indicate if there are certain facets customizable with the item, ex. certain verb interactions with Winged wear. In both the form and the template, this would be entered as "facet1", "facet2", or if multiple, "facet1,facet2...", specifically with a comma and no spaces to separate them.

Related Scripts

Formally known as "corresponding scripts," this parameter is used to enter script names that correspond with the item script. This is also known as a "script family". In both the form and the template, this would be entered as "script1", "script2", or if multiple, "script1,script2...", specifically with a comma and no spaces to separate them. Links are not required to be entered as the template handles that itself.

Add or Swap Eligible

The addorswap parameter of the template is used to indicate if a script can either be added or swapped to another item of the same class. If using the template directly, this would be entered as "Add", "Swap", or if both, "Add,Swap". In the form, these are checkboxes to check all that apply. This field corresponds with the Script add or swap eligible property.

Attunement

Attunement for item scripts specifically refers to script attunement on an item. This is typically in reference to an item that attunes upon first use, however certain items, such as those obtained from Event Vaults, are attuned at redemption. This does not refer to items purchased with the ATTUNE option. Valid options are either Permanent or Temporary. This field corresponds with the Item script attunement property.

Attunetype

The attunetype parameter in the template is use to indicate if the script is attuned to Account or Character. In the form, it appears as Attunement Type. This field corresponds with the Item script attunement type property.

Safety Feature

The safety parameter of the template is used to indicate if the script has a safety feature for when it is PUT or PLACEd on the ground for a limited duration, during which other players and the janitor cannot pick it up.

• All Mine: The All Mine safety feature will only work as long as the player remains in the room with the dropped item.
• Stay Put: The Stay Put safety feature allows for an item to be placed in a room and does not require the player to stay with it. Certain Stay Put items may be placed semi-permanently in private properties, lofts, or stalls by the owner.

Verbs Used

The verb parameter of the template is used to list verbs, preferably in alphabetical order, that the script utilizes. In both the form and the template, this would be entered as "verb1", "verb2", or if multiple, "verb1,verb2...", specifically with a comma and no spaces to separate them. This populates a table beneath the main ItemScriptInfo template. Verbs entered should be done in all caps only, and links are not required to be entered as the template handles that itself.

Original Release Information

While completely optional, many users enjoy seeing release information for an item, if it is known. This section creates a sentence within the introductory paragraph that handles that parameter.

Releasevenue

The releasevenue parameter of the template indicates which event or special venue an item script was originally released at, ex. Duskruin. In the form, it appears as "Original Release Venue". Links are not required to be entered as the template handles that itself.

Releasedate

The releasedate parameter of the template indicates when an item script was originally released. For most item scripts, this will be a year only, however certain events run twice a year, such as Duskruin, and entering the month along with the year is acceptable in these situations. In the form, it appears as "Original Release Date".

Origmerch

The origmerch parameter of the template indicates which merchant originally released the item script. This is not always known as some events do not have merchant activity. It is preferred to have a merchant name entered, however in lieu of that, a GM name may be entered instead, if known. In the form, it appears as "Original Release Merchant". Links are not required to be entered as the template handles that itself.

Quest Prize

The quest parameter of the template indicates if an item was released as part of participation in and completion of a quest, ex. Ghezyte quest items. This parameter should indicate the name of the quest, but omit the word "quest" as the template populates that automatically. Links are not required to be enter as the template handles that itself.

Features Altered

The features parameter of the template indicates which features a feature altering script will temporarily alter. This should be used if the type indicates it is a feature altering script. This is not the same as a glamour, and should not be use for that. In both the form and the template, this would be entered as "feature1", "feature2", or if multiple, "feature1,feature2...", specifically with a comma and no spaces to separate them.

• Height: Rarely, a temporary feature altering item may adjust a character's height.
• Body: At this time, body types cannot be temporarily altered, however it is listed for the sake of future use, in case one does.
• Eyes: This is used to indicate if a temporary feature altering item may alter a character's eye characteristic or eye color, ex. Ferocious Eyes mask.
• Complexion: This is used to indicate if a temporary feature altering item may alter a character's complexion (skin) field.
• Hair: This is used to indicate if a temporary feature altering item may alter a character's hair style, hair texture, hair color, or hair quirk.
• Face: This is used to indicate if a temporary feature altering item may alter a character's face field.
• Nose: This is used to indicate if a temporary feature altering item may alter a character's nose field.
• Distinguishing mark: This is used to indicate if a temporary feature altering item may alter a character's distinguishing mark field.
• Unique: This is used to indicate if a temporary feature altering item may alter a character's unique feature field.
• Wings: This is used to indicate if a temporary feature altering item may alter an aelotoi's wing characteristic or wing quirk, ex. Aelotoi Wing Jewels.

Additional Information Summary

The addinfo parameter of the template is used to give a quick summary of information that is not covered by the autogenerated introduction paragraph. There is a character limit of 200, with spaces included. Any more than that should be indicated in the Additional Information section.

Script Restrictions

The restrictions parameter of the template is used to indicate if there are specific restrictions on an item script, such as alteration restrictions, etc. The restrictions themselves should be indicated in the Restrictions section.

Loresong

The loresong parameter of the template is used to indicate if an item script has a loresong associated with it. The loresong itself should be indicated in the Loresong section.

Additional Information

Item Costs in Articles

Please do not add unlock costs or item costs to the individual item script pages as these costs vary between festivals, events, and shops. When these costs are added to the item page and the costs change or vary, it is unlikely they will be updated due to the way festival, event, and shop information is added to the wiki. It is rare for editors to be able to or have the time to track down every place that someone has put the now erroneous information, leaving this incorrect information all over the wiki with only the shop page having the correct information. This leads to readers who are confused by the conflicting information and aren't sure which information is most up-to-date. Instead, provide a link to the relevant shops the Additional Information section under a third-level section header labeled Availability.

Template Copy/Paste Code

Below is the copy/paste code for the ItemScriptInfo template if editing the page manually and without the item script form.

{{ItemScriptInfo
|propername=     yes or leave blank
|category=       Fluff, Mechanical, Mount or Private Property only.  If multiple, enter each with a comma, no spaces, to separate entries.
|class=          Accessory, Armor, Clothing, Container, Miscellaneous, Shield, Weapon only.  If multiple, enter each with a comma, no spaces, to separate entries.
|type=           Cookin, Crafting, Creature, Feature altering, Glamour, Storage, or Vissi only.  If multiple, enter each with a comma, no spaces, to separate entries.
|tiers=          The number of tiers to be fully unlocked.  If no tiers, leave blank.
|unlocks=        Bundling, Certificate, Merchant, Premium Unlocker, or Quest only.  If multiple, enter each with a comma, no spaces, to separate entries.  This will only populate if tiers are indicated.  
|itemscript=     flourish or script only.  If both, enter "flourish,script"
|releasevenue=   Name of the release venue.
|releasedate=    Year or Month/Year of the release.
|origmerch=      Name of the merchant who released, merchant name preferred if known.
|quest=          Name of quest (omitting the word quest) if an item was obtained as part of quest participation. 
|features=       height, body, eyes, complexion, hair, face, nose, distinguishing mark, unique or wings only.  If multiple, enter each with a comma, no spaces, to separate entries.
|customization=  List of facets able to be customized on an item by a merchant.  If multiple, enter each with a comma, no spaces, to separate entries.
|addorswap=      Add or Swap only.  If both, enter "Add,Swap"
|relatedscript=  List of scripts related to the item script (formerly known as corresponding script or script families).  If multiple, enter each with a comma, no spaces, to separate entries.
|attunement=     Permanent or Temporary only, if script is attuning.
|attunetype=     Account or Character only, if script is attuning.
|verb=           List of verbs used by the item script.  If multiple, enter each as all caps with a comma, no spaces, to separate entries.
|safety=         All Mine or Stay Put only, if script has a safety feature.
|addinfo=        Quick summary of additional information, limited to 200 characters total.
}}