Elanthipedia Items (script)

From Elanthipedia
Revision as of 15:56, 20 March 2011 by ISHARON (talk | contribs) (→‎Script)
Jump to navigation Jump to search
Elanthipedia Items (script)
Category information
Front-end Genie
Author Isharon


This script creates Elanthipedia forms for weapons, shields, armor, and items that you appraise in shops. The results are both echoed to the game window and logged to the Appraisal file in Genie's Logs folder.

This script is intended for experience Elanthipedia contributors only. The forms that are created by this script often require some manual editing. (See below for details.) Please check for errors before posting them to Elanthipedia.

Field values are not defined unless you are "certain" about the stat that you are appraising.

Instructions

Syntax

.ELANTH [ITEM NOUN]: You must type the entire noun. (For example, if you're appraising a greatsword, you must type greatsword; greats wouldn't work.)

Most of the time, the script needs to type shop/appraise X on Y, but sometimes, the required preposition is in. In these cases, edit the first line of the script before running it:

setvariable preposition on

When the script loads, it will send shop $shopv to check the surface that the item is on. (This is not required, but I find it helpful.) A menu will then prompt you to select the type of item you're appraising:

  1. Weapon: Melee/Thrown: most weapons (except types 2-5)
  2. Weapon: Ranged: bows, crossbows, and slings
  3. Weapon: Ammunition: for bows, crossbows, and slings
  4. Weapon: Brawling: worn brawling gear (excluding parry sticks)
  5. Weapon: Parry Stick
  6. Shield
  7. Armor
  8. Item: all other items


Required Genie Settings

You must install and use this alias to set the shop surface variable.

#alias {shopv} {#var shop $0}


The "shop surface" is the thing on which the item is placed (for example, table, second rack, or oak shelf).

You must install and run this script to set your currency variable. (It only needs to be run once unless you go to another province.) If you don't wear a ring, change the item to something that you wear.

put app my ring quick

matchre dokoras ^You .+ worth .+ dokoras
matchre kronars ^You .+ worth .+ kronars
matchre lirums ^You .+ worth .+ lirums
matchwait

dokoras:
put #var currency Dokoras
goto end

kronars:
put #var currency Kronars
goto end

lirums:
put #var currency Lirums
goto end

end:

echo
echo Currency set to $currency
echo

Changelog

03/20/2011: The script has the following new features:

  • adds commas to costs and appraisal values
  • adds the currency to the cost field (requires the script above)
  • equipment construction values don't need to be edited to make them consistent with Elanthipedia's template
  • recognizes gaethzen as a type of fluff item
  • recognizes many common guild and race styles for fluff items

Fields That Require Manual Editing

Name

Delete this field unless the item tap differs from the page name (for example, in capitalization).

Missing Data

Some fields that the script can't fill are left as placeholders for your convenience. For example, MTag (materials), CTag (colors), and STag (symbols) must be supplied by the player.

Likewise, any field with a % in the result has not been filled by the script. (These fields are in the script, because the script sometimes has values for them.) These fields should be deleted unless you know the appropriate value.

Fields to watch out for:

  • |type2=%wtype2: this field is used for thrown weapons
  • |maxcharge=%maxcharge: this field is filled when cambrinth is appraised. (Delete this field if the data is missing, or it is defined as "N/A".)
  • |special=%special: this field is defined as "cambrinth" when the item is cambrinth. Otherwise, delete this field unless there is some other special type, such as a guild or racial style.

Item Types

For your convenience, the script leaves room for up to four item types for fluff. Sometimes, the script will define a type for you. Some automatic settings:

  • |type=clothing: automatic for most clothing
  • |type=jewelry: automatic for most jewelry
  • |type=creation: automatic for fabrics
  • |type=-: automatic when the item is not set as clothing or jewelry
  • |type2=container: containers and pocketed items
  • |type3=cambrinth: cambrinth


If a type field is blank, please delete it.

If type2 or type3 is set, but there is no type, change it to the lowest available type number.

If type is defined as "-", it means that the item doesn't belong in any of Elanthipedia's type categories. This definition is incorrect if another type variable has been set (for example, container or cambrinth). When in doubt, delete this unless you know that no other item category applies.


Source, Sourcetype, and Cost

By default, the source field is defined as the room name. This does not always match the shop name on Elanthipedia.

Player-run Shops

If you are appraising items in player-run Trader shops, please delete the following fields unless you know the original source:

  • |sourcetype=sold by
  • |source=
  • |cost=

Swappable Weapons

This script supports thrown weapons, but it does not fully support swappable weapons, such as bastard swords. (It will only generate the damage and balance/power fields for one side of the weapon.)

The easiest way to handle this situation is to let the form supply the one side's values, save changes, and click the "edit with form" button to supply the other side's values.

Shields

In the Shield section of the script, there is a field called |paladinapp=Yes. Please delete this unless you are a Paladin. (Paladins get more detailed information about shield protection, and this field indicates that the shield was appraised by a Paladin.)

Armor

area: This field is not defined by the script. Instead, all possible areas are listed. Please delete the areas that aren't covered by the armor.

|area=head,eyes,neck,chest,back,abdomen,arms,legs,hands


Absorption: The absorption fields are filled out twice, and some values need to be deleted.

For most armor, absorption is the same for all damage types. When this is the case, keep the absorbance field and delete the following fields:

  • |punctureab=
  • |sliceab=
  • |impactab=
  • |fireab=
  • |coldab=
  • |electricab=


If absorption values are not the same for every damage type, you can delete the ones that are the same as absorbance. For example, let's say that a piece of armor has the following absorption stats:

good (5/11) protection and fair (3/11) damage absorption for puncture attacks.

good (5/11) protection and fair (3/11) damage absorption for slice attacks.
good (5/11) protection and moderate (4/11) damage absorption for impact attacks.
fair (3/11) protection and fair (3/11) damage absorption for fire attacks.
fair (3/11) protection and fair (3/11) damage absorption for cold attacks.

moderate (4/11) protection and fair (3/11) damage absorption for electrical attacks.

As you can see, most of the absorption values are "fair," but impact absorption is "moderate." The Elanthipedia form would look like this:

|absorbance=fair
|impactab=moderate

This tells Elanthipedia that every absorption value is fair except for impact, which is moderate.

Script

Bovi's Booty
Treasure Trove

> shop first cabinet
in the black oak cabinet, you see:

http://www.elanthipedia.com/w/index.php?title=Item:cassock haphazardly sewn with rubiginose clusters of cambrinth spangles&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:grey-green mage's robe appliqued with brown felt leaves&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:delicate silver locket dusted with sparkling black opal chips&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:pine-green cloak of elven silk embroidered with twining ivy vines&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:rough-spun brocade greatcloak with knotted fringe along the hem&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:enveloping pall of ragged black grogram&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:dark green frogs&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:pale blue scarf of sparkling moonsilk with a delicate sapphire lace trim&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:deep green scarf heavily laden with gold and amber beads&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:small glass spheres&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:long black feather wings&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:elegant sky-blue robe of transluscent gauze&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:green mosaic tiles&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:dark purple cloak embroidered at the edges with black webbing&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:hooded cloak of creamy white linen trimmed in royal blue silk&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:hammered gold earcuff worked with a bardic soul knot&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:blue damask tabard embroidered with the golden lion of chadatru&action=edit

> shop first rack
on the oak rack, you see:

http://www.elanthipedia.com/w/index.php?title=Item:firecat claw elbow blades&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:basilisk fang elbow blades&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:blackened great helm edged in silver&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:kra'hei fang knee spikes&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:blackened steel sword with an empty crest setting in the ebony hilt&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:blackened short sword etched with thin silver serpents&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:blackened steel stiletto with a bone-shaped crossguard&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:duraka skefne&action=edit

> shop first stand
on the oaken stand, you see:

http://www.elanthipedia.com/w/index.php?title=Item:oily green potion&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:white-metal fake claws&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:length of steelsilk fabric&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:audrualm dagger charms&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:length of rosy silk fabric&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:length of moonspun silk fabric&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:polished leather belt&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:several broom-riding witches&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:vivid sangyn silk dance veil&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:silver rope bracelet hung with a black crystal disc&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:wide silver ring set with an eventide moonstone disc&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:nacre prayer beads carved into miniature magpie&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:delicate lotus blossom with translucent lavender jade petals&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:polished silver warhorn engraved with raging stormclouds&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:hammered bronze armband set with a dusky bloodgem disc&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:wide gold wristband inset with a lustrous water opal disc&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:stylish phofe flower tailband&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:length of grey mistsilk fabric&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:weighted steel stilettos&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:set of reflective stars&action=edit

> shop first table
on the oak table, you see:

http://www.elanthipedia.com/w/index.php?title=Item:blue-white steelstars&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:gypsy marauders&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:oversized blunt arrowheads&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:cambrinth bumblebees&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:leather thigh bag heavily-beaded in cambrinth with the image of a wild maned lion&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:platinum and ruby ring&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:gold and emerald ring&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:silver and amethyst ring&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:gold and citrine ring&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:silver and moonstone ring&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:cambrinth anvils&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:cambrinth walruses&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:cambrinth pumpkins&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:polished cambrinth orb inlaid with a platinum thirteen-point star&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:dull blue leather combat pack fringed with embossed straps&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:albredine crystal ring&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:mosaic cambrinth medallion depicting the image of damaris's panther&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:heavy miniature herb cabinets&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:cerise silk surcoat embroidered with a grey horned owl&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:silver-dusted cambrinth orb etched with the likeness of a lion in regal repose surveying his domain&action=edit

> shop second table
on the deboar table, you see:

http://www.elanthipedia.com/w/index.php?title=Item:grey raccoons&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:set of colorful balls&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:furry wolves&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:engraved silver globes&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:miniature leafy forest woodwisps&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:miniature wooden pumpkins&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:gemstone lizards&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:elegant crystal vials&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:solid gold spheres&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:heavy wooden ladybug dangling from a string&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:carved applewood fans&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:miniature steel tower shields etched with the empaths' guild crest&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:jasper falcons&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:plush butterfly dangling from a string&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:miniature cross-eyed zombies&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:miniature pure white alfar avengers&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:set of roughly decorated cornhusk dolls&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:cambrinth war mammoths&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:stuffed centipede dangling from a string&action=edit
http://www.elanthipedia.com/w/index.php?title=Item:clay pottery fragments&action=edit