View source for Sid plugin


The Mush-Z sid plugin is an advanced alternative to the standard server shortID, it allows for a greater customization of the output and has a richer set of features. It is highly configurable however it may require an initial outlay of effort to learn and optimize it to your own personal preferences. To help those used to the standard Mush-z shortID syntax adjust 'sid' or 'sid on/off' is similar to 'config shortid', 'sid history all' is similar to 'config shortall' and 'sid comma' is similar to 'config shortidcomma'.

==Getting started and installing the plugin==
To install the plugin, Press Ctrl+Shift+P, Alt+A and select the mushz_sid.xml file. To use the plugin you must make sure config shortid is set to "1 - Disabled" in Mush-Z, or if you are not using Mush-Z that 'set shortid' is toggled to the long format. Once installed the plugin's features can be toggled on and off by typing 'sid' or  'sid on' or 'sid off'.

==How to use Sever shortID instead==
To use server shortID instead you must first remove the plugin, Press Ctrl+Shift+P scroll down to mushz_sid and press Alt+R, then set 'config shortid' to "2 - output and history", or type 'set shortid' if you are not using Mush-Z.

==Getting help==
Beyond the help provided in this guide you may type 'sid help' at any time to quickly review the syntax of the verious commands. To view the latest changes type 'sid changes' adding a number e.g. 'sid changes 3' if you wish to see more than the latest entry. To confirm which version you are on type 'sid version'.

==Display mode==
The sid plugin has three display settings none, shortID and longID these can be toggled by typing 'sid display'. None hides everything inside the kxwt_id band this means you may get no output when identifying something or just a line saying "You are carrying" and the name of the item. ShortID is the default and shows the short string based on your preferences. LongID shows the unmodified verbose string that is sent by the server.

==Further changing the display==
The sid plugin has a host of misc options for further customizing the display to your personal tastes, note these will only apply to the 2nd display mode, the 1st display mode will hide everything and 3rd mode will show the unmodified longID format, as explained in the section display mode.

To toggle adding of commas type 'sid comma', if you like to see "Item:" in front of the item you can type 'sid item_prefix' to enable this. Typing 'sid container' will always show item size for containers this can be useful if you have the item_size field set to hidden because you don't want to see it on other items.

===Extra lines===
By default the sid plugin will hide a lot of extra lines of text to keep the output as brief as possible however these can be reenabled, 'sid extra' will show extra footer lines such as composite text and 'sid unmatched' will show anything that is unmatched inside the kxwt band, an example of this would be on the mark of the dragon watch, the following line could be shown or hidden, depending on the setting:

{{MUDdisplay|This mark can be used once every twenty-four hours to transport the user to the Island of Morjah.}}

==Showing and bragging items==
Typing 'show id' or 'brag id' will show or brag the most recently identified item, Adding a number will specify a specific item to be shown or bragged for example 'brag id 2' will output the 2nd item you identified. Fields may also be specified for example 'show id level affects' will show the current item's  level and affects. Finally using the word full will output all fields for example 'brag id full'.

By default brag will use the say channel however this can be changed by typing a channel after the word brag for example 'brag gt id weight'.

==Field Customization==
The sid plugin has a powerful set of commands that allow you to completely customize how an item is either shown or bragged.

Any number of fields maybe shown or omitted by default. To include a field in the display type sid show add field for example 'sid show add weight', To hide a field from the display type sid show remove field for example 'sid show remove item_size'. For a list of all the valid options type 'sid fields'. To do this for the bragged output simply substitute the word show for the word brag for example 'sid brag add bound'. This command also accepts an all option so for example 'sid show add all' or 'sid show remove all' will add or remove all the fields from the show output.

===Field aliases===
To make it easier to type and remember some of the fields have aliases, which can be viewed by typing 'sid aliases' for example 'sid brag add ac' could be used instead of 'sid brag add defense'.


===Reordering fields===
The order in which fields are outputed can be changed by typing sid order field number for example 'sid order defence 1'. To see the current sequence type 'sid order list'. The commands 'sid show list' and 'sid brag list' can also be used as a reference to how items will be outputed.

===Affects===
Affect names come in two flavors: a shorter and a longer version, which can be toggled by typing 'sid affects'. The shorter strips the word down as much as possible for speed of reading but can sometimes be difficult to interpret, for example magecast level is abbreviated to mcl where as on the longer version it is magecast.

====Sorting affects====
Affects can be sorted by typing 'sid sort' by default they are unsorted and are listed in the order they are sent from the mud however by toggling to sorted they will be listed in order from highest to lowest, note when disenchanting you should toggle to unsorted or use 'show object item' instead this is because disenchant requires an affect number.

==Reviewing item history==

===Adding shortID to channel history===
The shortID plugin can interact with the channel_history plugin by populating the shortID buffer with items that are identified to do this type 'sid history' and to toggle adding to the all buffer type 'sid history all'. These settings will work regardless of which display mode you use so it is possible to view the longID or even hide the output all together and still have it save to the history buffers.

===The item history list===
While you may review the shortID history with the channel_history plugin, the sid plugin also has it's own internal store which offers more flexiblity, this can be invoked by typing 'sid list' and by default it shows the last 10 identified items however this can be changed by typing sid max number e.g. 'sid max 20'.

====Listing ranges====
 The list command also accepts specifying ranges e.g. 'sid list 2 5' will show items 2 to 5, 'sid list -3' will show the last 3 items and 'sid list 20' will show item 20 to the last identified item. 
 
 ====Listing specific fields====
 Another neat feature of the list command is the ability to specify a subset of fields to show for example i've just finished a crafting session and I want to review which items were mastercraft I could type 'sid list quality'. To specify more than one field separate each field with a space, for example after consecrating my tankset I want to see the armor and what affects were added I could type 'sid list -16 ac affects'. The full keyword can also be used to output all fields for example 'sid list full'.
 
 ==Managing your preferences==
To save your preferences type 'sid save' and to load them type 'sid load', to revert back to the defaults type 'sid reset'.
 
==Other features==
===How to output equipment you are wearing to a notepad window===
Another useful feature of the shortID plugin is the ability to output all the stats of all your worn equipment to a Mushclient notepad window, to do this type 'sid note' followed by 'ideq'.

[[Category:Mushz plugin]]