Gswiki:Style guide/Item scripts: Difference between revisions

The official GemStone IV encyclopedia.
< Gswiki:Style guide
Jump to navigation Jump to search
m (GS4-XERAPHINA moved page Help:Item scripts to Gswiki:Style guide/Item scripts: moving to subpage to Gswiki:Style guide)
No edit summary
Line 1: Line 1:
{{TOCright}}
{{work-in-progress}}{{TOCright}}
In order to streamline the process for creating and editing item/script pages on the Wiki, a series of templates have been created. These templates, along with this guide and the provided examples, serve to ensure formatting and categorization remain uniform across the various pages.
'''Item script pages''' are articles displaying information about scripted items within GemStone IV. A series of templates have been created to assist in cataloging this information, and along with this guide and the provided examples, serve to ensure formatting and categorization remain uniform across the various pages.


In order to streamline the process for creating and editing item script pages on the Wiki, an [[Form:Item_script|item script form]] is available with instructions and easy input for parameters.
==Categories==

As part of this update, categories for items and their scripts have seen a revamp as well. Below is a list of what categories are to be used moving forward, as well as where they should be entered within the [[Template:Iteminfo|Iteminfo template]].
===Type===
==Article Name==
Scripted items will often have a "script name" found in the item's [[Verb:ANALYZE|{{boldmono|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.
The entry slots for these in the iteminfo template are '''type''', the main item type, and '''type2''', the item's sub-type.

* [[:Category:Mechanical item scripts | Mechanical item scripts]]: 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]].
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.
* [[:Category:Fluff item scripts | Fluff item scripts]]: 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 Parka]]s, [[Veola hair accessory| Veola hair accessories]], [[Peretta gown]]s.

* [[:Category:Feature altering item scripts | Feature altering item scripts]]: These scripts are either mechanical or fluff, but have the ability to alter a character's features. Examples include: [[Peretta mask]]s, [[hairpick]]s, [[Veola hair accessory | Veola hair accessories]].
==Article Creation==
* [[:Category:Crafting item scripts|Crafting item scripts]]: These scripts apply to items that can be used as part of the process to craft something, including specialized storage of crafting supplies. Examples include: [[Knitting needles]] and [[Yarn bowl]]s for the knitting system.
===Proper Name===
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===
{{:Category:Flourishes}}

; 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 [[Property:Item script|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 [[Property:Item script category|item script category property]].


'''Please note:''' An item will either be '''mechanical''' (ie. it provides the user with a [[:Category:Combat Mechanics|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.
'''Please note:''' An item will either be '''mechanical''' (ie. it provides the user with a [[:Category:Combat Mechanics|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 Parka]]s, [[Veola hair accessory| Veola hair accessories]], [[Peretta gown]]s.
* [[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===
===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|restrictions]].
The entry slots for these in the iteminfo template are '''itemclass(2-3)'''.

* [[:Category:Armor item scripts | Armor item scripts]]: These scripts apply solely to armor.
* [[:Category:Accessory item scripts | Accessory]]: These scripts apply to accessory items only. Applicable worn locations (based on {{boldmono|[[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]].
* [[:Category:Weapon item scripts | Weapon item scripts]]: These scripts apply solely to weapons.
* [[:Category:Shield item scripts |Shield item scripts]]: These scripts apply to shields.
* [[:Category:Armor item scripts | Armor]]: These scripts apply solely to armor.
* [[:Category:Clothing item scripts | Clothing item scripts]]: These scripts apply to clothing items. Applicable worn locations (based on {{boldmono|[[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 gown]]s.
* [[:Category:Clothing item scripts | Clothing]]: These scripts apply to clothing items. Applicable worn locations (based on {{boldmono|[[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 gown]]s.
* [[:Category:Accessory item scripts | Accessory item scripts]]: These scripts apply to accessory items only. Applicable worn locations (based on {{boldmono|[[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]].
* [[:Category:Container item scripts | 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.
* [[:Category:Container item scripts | Container item scripts]]: 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.
* [[:Category:Miscellaneous item scripts | Miscellaneous]]: These scripts apply to items that do not fall within the aforementioned categories. Examples include: [[gemcutter]]s, [[lapidary box]]es.
* [[:Category:Creature item scripts | Creature item scripts]]: These scripts apply to creature-type items, such as pets, ex. [[Dhu kitten]]s or [[Mount]]s.
* [[:Category:Shield item scripts |Shield]]: These scripts apply to shields.
* [[:Category:Miscellaneous item scripts | Miscellaneous item scripts]]: These scripts apply to items that do not fall within the aforementioned categories. Examples include: [[gemcutter]]s, [[lapidary box]]es.
* [[:Category:Weapon item scripts | Weapon]]: These scripts apply solely to weapons.

<nowiki>*</nowiki>'''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.
<nowiki>*</nowiki>'''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
==Right Side Infoboxes==
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 [[Property:Item script classification|Item script classification property]].
These templates allow for a quick at a glance look at the script.<br>

* [[Template:Iteminfo]] - This template features all the need to know information and will either grow or shrink based on information entered.
===Type===
* [[Template:Itemverb]] - This template contains a list of verbs used on the item, with clickable links to the verb page itself. This is an optional table, and can be omitted if the article is short enough to not necessitate it.
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.

* [[:Category:Cooking item scripts|Cooking]]: These scripts are used in the [[cooking system]].
* [[:Category:Crafting item scripts|Crafting]]: These scripts are used in the various [[crafting]] systems.
* [[:Category:Creature item scripts | Creature]]: These scripts apply to creature-type items, such as pets, ex. [[Dhu kitten]]s or [[Mount]]s.
* [[:Category:Feature altering item scripts|Feature altering]]: These scripts can alter one's features.
* [[:Category:Glamour item scripts|Glamour]]: These scripts can apply a glamour in various spots, ex. [[Illusion prop]]s.
* [[:Category:Storage item scripts|Storage]]: These scripts apply primarily to containers and allow for stacked storage, often weightlessly, within them, ex. [[Perfuminator]] or [[Bag of Holding]].
* [[:Category:Vissi item scripts|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 [[Property:Item script type|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 [[Property:Item script tiers|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 [[Property:Item script unlock|Item script unlock property]].

* [[Bundling]]: Bundling unlocks refers to whether you can [[Verb:BUNDLE|BUNDLE]] or [[Verb:ADD|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 [[Property:Script add or swap eligible|Script add or swap eligible property]].

===Attunement===
'''Attunement''' for item scripts specifically refers to [[Item attunement#Script Attunement|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 Vault]]s, are attuned at [[Verb:REDEEM|redemption]]. This does not refer to items purchased with the [[Verb:ATTUNE|{{boldmono|ATTUNE}}]] option. Valid options are either Permanent or Temporary. This field corresponds with the [[Property:Item script attunement|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 [[Property:Item script attunement type|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 [[Verb:DROP|PUT]] or [[Verb:PLACE|{{boldmono|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 property|private properties]], [[loft]]s, or [[stall]]s 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
==Page Subheaders==
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".
For typical item pages, the breakdown was Analyze, Usage, Additional Information (including links to other pages/resources). Going forward, pages that cover a script on a single item type (eg. [[Compartmentalized quiver]], [https://gswiki.play.net/Pirate_Harness Pirate Harness]) will be broken down into Analyze, Tiers (with each tier being its own subheader), Additional Information. Pages that cover scripts that can be applied to multiple items (eg. [[Yansio clothing]], [[Veola hair accessory]]) will will have a similar setup, however the Item will go in place of the Tier. This will allow uniformity between fluff item script pages and mechanical item script pages. Optional templates were created that can be used for both types, one for single item type pages, and one for multi-item type pages.
* [[Template:Itemtier]] - Optional template for single item pages with spots for Tier (or tree), Item Summary (a quick breakdown of information for the unlock, if any), Analyze (if the tier unlock differs greatly from the base analyze. This does not include if there are only additional verbs for the unlock tier. An example would be [[Compartmentalized quiver]]s, which note a drastic difference in the analyze between unlock tiers), Affinity (if affinity is specific to the item/tier), and Itemverbtable (this will create an additional subheader for Usage, which should be followed by the item's verb usage set up in [[Template:Verbtable]]. Each tier would require the use of this template.
** Copy/paste Code for [[Template:Itemtier]]:
: <pre{{log2}}><nowiki>{{itemtier <!-- Copy/Paste x #Tier for item as needed. -->
|tier= <!-- REQUIRED: Must be entered as Tier # or Tree (Name) -->
|itemsummary= <!-- Brief explanation of what this tier does, if any. -->
|analyze= <!-- Tier 1/OTS required to be listed here. Other tiers only to list changes between analyzes (so as to not populate duplicate information), and final unlock to be listed in full. -->
|affinity= <!-- Brief explanation of affinity for that specific tier, if any. -->
|itemverbtable= <!-- Answer YES if there are verbs associated with this tier. If not, leave blank. -->
}}
{| {{verbtable|90}} <!-- REQUIRED if there are verbs for this tier. For instructions on how to use this template, see Template:Verbtable. -->
|}</nowiki></pre>
* [[Template:Itemtiermulti]] - Optional template for multi-item pages with spots for Item (in place of tier), Item Summary (a quick breakdown of information for the item, if any) Analyze (for the purposes of simplified formatting, only the highest tiered {{boldmono|ANALYZE}} of each item under the script should be recorded here), Affinity (if affinity is specific to the item), and Itemverbtable (this will create an additional subheader for Usage, which should be followed by the item's verb usage set up in [[Template:Verbtable]]. Each item would require the use of this template.
** Copy/paste Code for [[Template:Itemtiermulti]]:
: <pre{{log2}}><nowiki>{{itemtiermulti <!-- Copy/Paste x #Item as needed. -->
|item= <!-- REQUIRED: Must be entered as Item Type -->
|itemsummary= <!-- Brief explanation of what this particular item does, if any. -->
|analyze= <!-- Tier 1/OTS required to be listed here. Other tiers only to list changes between analyzes (so as to not populate duplicate information), and final unlock to be listed in full -->
|inspect= <!-- ONLY for when an item has a custom INSPECT to it. -->
|show= <!-- ONLY for when an item has a hard-coded show. -->
|affinity= <!-- Brief explanation of affinity for that specific item, if any. -->
|itemverbtable= <!-- Answer YES if there are verbs associated with this item. If not, leave blank. -->
}}
: {| {{verbtable|90}} <!-- REQUIRED if there are verbs for this tier. For instructions on how to use this template, see Template:Verbtable. -->
|}</nowiki></pre>


; Origmerch
==Additional Information==
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.
When creating a page for a new item, please remember to utilize {{boldmono|<nowiki><pre{{log2}}></nowiki>}} to record the item's {{boldmono|ANALYZE}}. This is unnecessary if you are placing the analyze text into the [[Template:Itemtier|itemtier template]]. It should, however, still be used to record any ambients or additional logs of the item in use.
An example of proper page order setup is:
<pre{{log2}}>
* Small paragraph blurb about item and release information. (noted by <nowiki>{{addmetext}}</nowiki> in the below copy and paste code).
* Tier or Item breakdown and information (utilizing either {{boldmono|[[Template:Itemtier]]}} for single item pages or {{boldmono|[[Template:Itemtiermulti]]}} for multi-item pages).
** {{boldmono|[[Template:Verbtable]]}} should be used and broken up between each tier/item subheader.
* Additional information (this should include any additional pertinent information not covered in the above areas).
** Ambient messaging
** Log of use (if any)
* Resources/See Also (links to additional information, festival/shop release information, saved posts subpage).
</pre>


===Multi-Item Pages===
===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 item]]s. 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.
Multiple item pages require additional work to properly format due to the nature of the templates and pages. The [[:Template:Itemtiermulti | Itemtiermulti template]] has been set up in a way that indents subheaders following the main item to keep them from blending too much into the rest of the page's content. When setting up the [[:Template:Verbtable | Verbtable template]], a {{boldmono|<nowiki>:</nowiki>}} should be placed before the start of the table to indent it and keep it in line with the multi-item template. Each tier should be included in one table per item, in lieu of separating tiers under separate headers. These pages are the exception, not the rule. In the event that a multi-item script requires additional formatting, it is recommended to manually create the pages without the template, but follow the same format. An example of ideal formatting for a multi-item page is [[Veola hair accessory]].


===Features Altered===
====Difference between Multi-Item Pages and Corresponding Script Pages====
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.
When attempting to determine whether a group of items should be considered for multi-item pages or separated, it is important to note the following.
* Multi-Item Pages
** Script Variations - These are items that share the same script, but have different variations/messaging to them based on a type. Examples would be [[Book Buddies]] or [[Saddle Me Up saddle|saddles]].
** Script Families - Similar to Script Variations, however these items may actually be varied in type, or may each have a different script name. They can work separately, or they may work with other items within that family, but it is not necessarily required. It may also be that some of the items in the script family do not work on their own at all, and require pairing with another in the script family to work properly. This is the most common use of multi-item pages. Examples would be [[Ghule|Ghule items]] or [[Yansio clothing]].
** '''Exceptions''': It is important to note that not all items within the above groups would qualify to be on the same page due to the sheer length of information available. See [[#Main/Landing Pages|Main/Landing Pages]] for an example of what qualifies for this and how to handle it.
* Corresponding Item Pages
: Create separate articles in cases where there are independent scripts that work on their own and are not part of a single script family. These scripts may work with other scripts for customization, but are not all required to work together. For clarification, Script A, B, and C are on separate pages. A works with B and C, but B and C do not work together. These are corresponding item scripts and ''not'' a script family.
: These types of scripts are seen less frequently than the ones noted under Multi-Item Pages. An example of this would be [[bloodrune]]s. Certain ones can be marked with [[blood-infused crystal]]s to change how they display when put into a [[MoonShard pendant]], but they can also be used in [[Bloodrune Holder]]s and [[Moody Garment]]s. Additionally, legendary bloodrunes can be used with a MoonShard pendant and matching Legendary Bloodrune Cloak for additional messaging.


* [[Height]]: Rarely, a temporary feature altering item may adjust a character's height.
====Main/Landing Pages====
* [[Body]]: At this time, body types cannot be temporarily altered, however it is listed for the sake of future use, in case one does.
When items from a script "family" (eg [[Legendary Bloodrune Cloak]]) would make more sense to be broken up into individual pages due to the length of information available or specific differences in the items, a main (or landing) page would be necessary. 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.
* [[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]].


===Item Costs on Pages===
===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|Additional Information]] section.
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 either in the first introductory paragraph or include links to the item shops in the Additional Information section under a third-level section header labeled Resources.


===Script Restrictions===
==Copy/Paste Code==
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|Restrictions]] section.
Below is the full copy/paste code for the templates used to create an item/script page. Optional templates are [[Template:Itemtier]] and [[Template:Itemverb]]. The below code will set the page up to allow the [[:Help:Item scripts#Right Side Infoboxes|right side infoboxes]] to float properly alongside the verb tables for item usage. Text within <nowiki><!-- and --></nowiki> will not appear on the page; these notes are hidden instructions and should be left in the pages to inform future editors.
<pre{{log2}}><nowiki>
<table><tr valign="top"><td><!-- Please see </nowiki>'''Help:Item scripts'''<nowiki> page for instructions on how to properly create and format an item page.-->
{{addmetext}} <!-- This spot reserved for informational blurb for item. Remove as part of copy/paste.-->
{{TOC limit|2}}
{{itemtier <!-- Copy/Paste x #Tier for item as needed. -->
|tier= <!-- REQUIRED: Must be entered as Tier # or Tree (Name) -->
|itemsummary= <!-- Brief explanation of what this tier does, if any. -->
|analyze= <!-- Tier 1/OTS required to be listed here. Other tiers only to list changes between analyzes (so as to not populate duplicate information), and final unlock to be listed in full. -->
|affinity= <!-- Brief explanation of affinity for that specific tier, if any. -->
|itemverbtable= <!-- Answer YES if there are verbs associated with this tier. If not, leave blank. -->
}}
{| {{verbtable}} <!-- REQUIRED if there are verbs for this tier. For instructions on how to use this template, see </nowiki>[[Template:Verbtable]]<nowiki>. -->
|- {{verbtableheader|90}}
! scope="col" style="width:5em;"|Verb
! scope="col" style="width:5em;"|Style <!-- (Only if applicable. Additional options would be Demeanor, Location, Climate, etc. Essentially, modifiers to the verbs.) -->
! scope="col"|First
! scope="col"|Second (Only if applicable)
! scope="col"|Third
|-
! scope="row" role="rowheader"|Verb
! scope="row" role="rowheader"|Style
|<!-- First Person View --> {{addmetext}}
|<!-- Second Person View --> {{addmetext}}
|<!-- Third Person View --> {{addmetext}}
|}
</td><td>
{{iteminfo
|type= <!-- REQUIRED: Mechanical or Fluff. OPTIONAL: If an item is feature altering or crafting, as well, please enter "Feature altering" or "crafting" below this line for "type2=" -->
|itemclass= <!-- REQUIRED: Valid options are: Armor, Weapon, Shield, Clothing, Accessory, Container, Creature (Pets/Mounts), or Miscellaneous. If more than one classification, additional lines can be added with "itemclass2=" & "itemclass3=" -->
|itemtype= <!-- REQUIRED: What items can this apply to. Up to 8 can be specified by setting "itemtype2" - "itemtype8". -->
|alter= <!-- REQUIRED: Can this be altered? Valid response is Yes or No. If there are restrictions, enter in Restrictions line at the end of this particular template. -->
|ld= <!-- REQUIRED: Is this item able to be lightened or deepened? Valid response is Yes or No. If there are restrictions, enter in Restrictions line. -->
|feature= <!-- OPTIONAL: This area is only REQUIRED if feature altering is indicated. Up to 8 features can be entered by setting "feature2=" - "feature8=". -->
|customize= <!-- OPTIONAL: Enter "Yes" if the item is customizable beyond an ALTER. If no, leave blank. -->
|custom= <!-- OPTIONAL: This area is REQUIRED if customization is indicated. Up to 5 customizations can be entered with "custom2=" - "custom5=". If the messaging is alterable, simply enter "Verb".-->
|origmerch= <!-- OPTIONAL: This area is for indicating the original release merchant name, if known. If released as a quest item, please enter "Quest" ONLY. Otherwise, leave blank.-->
|releasevenue= <!-- OPTIONAL: This area is for indicating the original release venue only, if known. If not, leave blank. -->
|releaseyear= <!-- OPTIONAL: This area is for indicating the original release year only, if known. If not, leave blank. -->
|questitem= <!-- OPTIONAL: Enter "Yes" if the item's release was part of a quest/storyline. If no, leave blank. -->
|tiered= <!-- OPTIONAL: Enter "Yes" if the item is tiered. If no, leave blank. -->
|tiersnumber= <!-- OPTIONAL: This area is only REQUIRED if an item has tiers. It is to note how many tiers there are (This includes off the shelf). -->
|unlock= <!-- OPTIONAL: This area is only required if an item has tiers. It is to note how tiers can be unlocked. Valid options are "Merchant", "Certificate", or "Quest" ONLY. If more than one, enter at unlock2.-->
|legendary= <!-- OPTIONAL: Enter "Yes" if the item/script was released/distributed at an auction or was a jackpot prize. Extremely limited release only (3 or less in existence). -->
|demeanor= <!-- OPTIONAL: Enter "Yes" if the item's messaging is affected by DEMEANOR. If no, leave blank. -->
|loresong= <!-- OPTIONAL: Enter "Yes" if the item has a loresong as part of the base script. If no, leave blank. -->
|corrscript= <!-- OPTIONAL: This area is for indicating if an item has scripts that correspond with it, specifically, they are scripts that work separately AND together in one way or another (i.e. Bloodrunes and MoonShard Pendants). Additional slots can be added with "corrscript2=" - "corrscript5"= -->
|attune= <!-- OPTIONAL: This area is for indicating if an item attunes. If permanent, enter Permanent; if temporary, enter Temporary (as in, it can be broken). If there is none, leave blank. -->
|attunement= <!-- OPTIONAL: This area is only REQUIRED if attunement was indicated. Options are "Character" or "Account". Please note, "Temporary attunement" will ALWAYS be "Character". -->
|affinity= <!-- OPTIONAL: Enter "Yes" if the item requires affinity to work. If no, leave blank. -->
|spell= <!-- OPTIONAL: This area is for indicating if an item has a spell inherent to the script ONLY. Up to 4 may be specified with "spell2=" - "spell4=". Example to enter: Call Familiar (920). If no, leave blank. -->
|enhancive= <!-- OPTIONAL: This area is for indicating if an item has enhancives inherent to the script ONLY. Answer YES. If no, leave blank. -->
|swap= <!-- OPTIONAL: This area is for indicating if an item is eligible for script swapping. Answer YES. If no, leave blank. -->
|add= <!-- OPTIONAL: This area is for indicating if the script is eligible to be added to an item. Answer YES. If no, leave blank. -->
|restrictions= <!-- OPTIONAL: This area is for indicating if an item has specific restrictions. If more than one, separate with <br>. DO NOT ENTER ON A SEPARATE LINE. -->
}}
{{itemverb
|verb= <!-- Verbs MUST be capitalized when entered. Up to 28 verbs can be added with "verb2=" - "verb28=". Verbs should be listed in alphabetical order, not by tier.-->
}}
</td></tr></table>
</nowiki>
</pre>


===Loresong===
[[Category:Help]]
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|Loresong]] section.
[[Category:Items]]

Revision as of 15:24, 22 August 2026

This article is a work in progress!

Item script pages are articles displaying information about scripted items within GemStone IV. A series of templates have been created to assist in cataloging this information, and along with this guide and the provided examples, serve to ensure formatting and categorization remain uniform across the various pages.

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.

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.

Article Creation

Proper Name

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.

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.

Retrieved from "https://gswiki.play.net/index.php?title=Gswiki:Style_guide/Item_scripts&oldid=264430"