Lich:Festshop script

5/31/19: A NEW VERSION OF THE FESTSHOP SCRIPT HAS BEEN UPLOADED

The festshop script is used by GSWiki contributors to catalog shops at festivals (and in game that do not use the ORDER system. It was created by Archsenex's player (based on Tillmen's Player Shop inventory script), and later expanded upon by GSWiki moderator, PFLATS.

Each festival shop listing may be set up differently, depending on how many shops it has and/or how many people are contributing.

Download and General Instructions

The latest change (May 31, 2019) was made by VANKRASN39 to update output for Rumor Woods 2019 shop listing and recognize Raikhen currency. It can be downloaded here.

This is a Lich (software) script and one must be logged into the game through Lich to use it.

By running ;festshop the script will survey the room and take inventory of all the containers. It will end by outputting the base wiki code for that room. This is only the start of the listing. The script will turn ;sorter off and on, but it is recommended to keep it off for getting follow-up information.

Each shop table will have 4 columns with the item tap description (the full description that might not be there when looking in the container) in the first column and the price in the last column (if the currency is released after the last script update, the script will likely need to be updated again). The other two columns can be any information as the tables do not have headers. The script will automatically inspect containers and weapons/armor, but an item's script may prevent it from being inspected. Look through the shop scan for show descriptions, read any scrolls or certificates, and add any information from the signs to the item tables.

A single container surface (in, on, under, or behind) can be cataloged using ;festshop {in/on/under/behind} {container} --slow

Free food/other items will automatically be stowed, make sure STOW is set to a container with room.

Slow mode: ;festshop --slow will run the script slightly slower to help ensure that all items are listed.

Please do not run the script in a shop without at least giving the shop a once over for hidden signs, odd containers, etc. It does not help much if you only run the script and do not do the other steps; the shop will likely have to be done again. Running the script in the background while doing other things will not result in an accurate, helpful list.

Instructions Within the Script

The following instructions appear after the wiki output code. Following these instructions, especially the second one, will improve the quality and accuracy of the list.

---Insert code at the top of the shop page, just below any __TOC__---

---Don't forget to SEARCH each room and LOOK AT/IN/ON/UNDER/BEHIND all furniture for hidden entrances---

---The code above ===roomname=== should only be entered for the first room of the shop.---

---Replace roomname in that line with a short description of the current room (East Room, Office, Through Door, etc.)---

---If there are a lot of Entry or other similar room headers, make it unique (e.g. include initials or part of shopname)---

Known Errors

• The script is known to miss some items, especially if the game is running slowly. A quick visual comparison should be made of number of items in a container and those listed in the output code.

• In lag-heavy situations, ;festshop --slow is advised.

• The script will not work on nested containers.
• If the shop clerk gives an overly convoluted speech while giving a price, the script will not understand and will not output any code.

Live Help

For live help, please join the GSWiki Slack Channel. If it is during a festival, someone who can help will likely be paying attention, or will see the issue in the near future.

Example Scan

Click to view log of a shop scan...

The resulting shop listing can be seen here.

>;festshop
--- Lich: festshop active.
[festshop]>look
[Faded and Desiccated]
The leather panels of a Tehir-styled pavilion hide the walls in this small building, complete with short strings of amber beads hanging from the roof.  A three-flamed oil lamp on a spindly brass stand fills the room with light and the scent of sandalwood, while a layer of furs covers whatever floor lies underfoot.  Near the oil lamp, a cedar display stand occupies the shop's center, a small table sits to one side, and an armor rack stands near the back wall.  You also see a newly painted sign.
Obvious exits: out
>
[festshop]>read #129353896
In the Common language, it reads:

     ~~  Barely made the boat, but here is what I brought! ~~
    Pouches are ONLY for gems, but are secure against thieving.
           ALL secure gem pouches can now be UNLOCKED.
        Unlocked pouches help you grab many gems at once!
                 Armor is said to be Al'Dur tribe wear.
              Amulet and talisman are crystal holders.
     Pendant is Unpoison, 10 charges, crumbles.  No recharge.
Tentacles are Neutralize Curse, 10 charges, crumbles.  No recharge.

>
[festshop: System Thinks this is an object!! - -454869]
[festshop]>look in #-454869
There is nothing in there.
>
[festshop: Nothing found for container and adverb combination]
[festshop]>look on #-454869
On the cedar table you see a copper ridgeweaver amulet tarnished to an ebon patina, a copper selshis talisman, a bracelet of dried qahzumar tentacles and a bronze qahzumar pendant with lapis tentacles.
>
[festshop: Plain old container found!]
[festshop]>get #129353913
A sales clerk says, "A copper ridgeweaver amulet will cost 10 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353913
You carefully inspect a copper ridgeweaver amulet tarnished to an ebon patina.

You determine that you could wear the amulet around your neck.  The amulet appears to serve some purpose.
>
[festshop]>exam #129353913
You take a closer look at a copper ridgeweaver amulet tarnished to an ebon patina.
The ridgeweaver amulet has a single, empty setting.
>
[festshop]>get #129353912
A sales clerk says, "A copper selshis talisman will cost 10 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353912
You carefully inspect a copper selshis talisman.

You determine that you could wear the talisman around your neck.  The talisman appears to serve some purpose.
>
[festshop]>exam #129353912
The selshis talisman has a single, empty setting.
>
[festshop]>get #129353911
A sales clerk says, "A bracelet of dried qahzumar tentacles will cost 5 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353911
>
You carefully inspect a bracelet of dried qahzumar tentacles.

You determine that you could wear the tentacles around your wrist.  The tentacles appears to serve some purpose.
>
[festshop]>exam #129353911
You see nothing unusual.
>
[festshop]>get #129353910
A sales clerk says, "A bronze qahzumar pendant will cost 5 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353910
You carefully inspect a bronze qahzumar pendant with lapis tentacles.

You determine that you could wear the pendant around your neck.  The pendant appears to serve some purpose.
>
[festshop]>exam #129353910
You take a closer look at a bronze qahzumar pendant with lapis tentacles.
You see nothing unusual.
>
[festshop]>look under #-454869
There is nothing under there.
>
[festshop: Nothing found for container and adverb combination]
[festshop]>look behind #-454869
There is nothing behind there.
>
[festshop: Nothing found for container and adverb combination]
[festshop: System Thinks this is an object!! - -454868]
[festshop]>look in #-454868
There is nothing in there.
>
[festshop: Nothing found for container and adverb combination]
[festshop]>look on #-454868
On the armor rack you see an ebon hounskull bearing sikuust mandibles as backswept horns, a morduska hide back scabbard cross-wrapped with copper straps, a sikuust chitin round shield with an ebon vultite frame, some sikuust chitin vambraces and some sikuust chitin greaves.
>
[festshop: Plain old container found!]
[festshop]>get #129353908
A sales clerk says, "An ebon hounskull will cost 20 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353908
>
You carefully inspect an ebon hounskull bearing sikuust mandibles as backswept horns.

Your careful inspection of an ebon hounskull bearing sikuust mandibles as backswept horns allows you to conclude that it is miscellaneous armor that covers the head.

You determine that you could wear the hounskull on your head.  The hounskull appears to serve some purpose.
>
[festshop]>exam #129353908
You take a closer look at an ebon hounskull bearing sikuust mandibles as backswept horns.
You see nothing unusual.
>
[festshop]>get #129353907
A sales clerk says, "A morduska hide back scabbard will cost 10 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353907
You carefully inspect a morduska hide back scabbard cross-wrapped with copper straps.

You estimate that a morduska hide back scabbard cross-wrapped with copper straps can store a slightly small amount with enough space for one item.

You determine that you could wear the scabbard, slinging it across your shoulders and back.  The scabbard appears to serve some purpose.
>
[festshop]>exam #129353907
You take a closer look at a morduska hide back scabbard cross-wrapped with copper straps.
You see nothing unusual.
>
[festshop]>get #129353906
A sales clerk says, "A sikuust chitin shield will cost 2500 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353906
You carefully inspect a sikuust chitin round shield with an ebon vultite frame.

Your careful inspection of a sikuust chitin round shield with an ebon vultite frame allows you to conclude that it is a large shield that protects the bearer if carried in the left hand.

You determine that you could wear the shield, slinging it across your shoulders and back.  The shield appears to serve some purpose.
>
[festshop]>exam #129353906
You take a closer look at a sikuust chitin round shield with an ebon vultite frame.
You see nothing unusual, except for a small enchanter's glyph.
>
[festshop]>get #129353905
A sales clerk says, "Some sikuust chitin vambraces will cost 5 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353905
You carefully inspect some sikuust chitin vambraces.

Your careful inspection of some sikuust chitin vambraces allows you to conclude that it is miscellaneous armor that covers the arms.

You determine that you could wear the vambraces around your arms.  The vambraces appear to serve some purpose.
>
[festshop]>exam #129353905
>
[festshop]>get #129353904
You see nothing unusual.
>
A sales clerk says, "Some sikuust chitin greaves will cost 5 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353904
You carefully inspect some sikuust chitin greaves.

Your careful inspection of some sikuust chitin greaves allows you to conclude that it is miscellaneous armor that covers the legs.

You determine that you could wear the greaves around your legs.  The greaves appear to serve some purpose.
>
[festshop]>exam #129353904
You see nothing unusual.
>
[festshop]>look under #-454868
There is nothing under there.
>
[festshop: Nothing found for container and adverb combination]
[festshop]>look behind #-454868
There is nothing behind there.
>
[festshop: Nothing found for container and adverb combination]
[festshop: System Thinks this is an object!! - -454867]
[festshop]>look in #-454867
There is nothing in there.
>
[festshop: Nothing found for container and adverb combination]
[festshop]>look on #-454867
On the display stand you see a tanned yierka hide pouch with amber-beaded drawstrings, a fine-linked ora chainmail pouch, a golden suede pouch with sandruby-beaded drawstrings, a deep blue brocade pouch with braided silver drawstrings and a crimson leather pouch with black braided drawstrings.
>
[festshop: Plain old container found!]
[festshop]>get #129353902
A sales clerk says, "A tanned yierka hide pouch will cost 50 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353902
You carefully inspect a tanned yierka hide pouch with amber-beaded drawstrings.

You estimate that a tanned yierka hide pouch with amber-beaded drawstrings can store a fairly small amount with enough space for any number of items.

You determine that you could wear the pouch, attaching it to your belt.  The pouch appears to serve some purpose.
>
[festshop]>exam #129353902
You take a closer look at a tanned yierka hide pouch with amber-beaded drawstrings.
>
[festshop]>get #129353901
A sales clerk says, "A fine-linked ora chainmail pouch will cost 50 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353901
You carefully inspect a fine-linked ora chainmail pouch.

You estimate that a fine-linked ora chainmail pouch can store a fairly small amount with enough space for any number of items.

You determine that you could wear the pouch, attaching it to your belt.  The pouch appears to serve some purpose.
>
[festshop]>exam #129353901
>
[festshop]>get #129353900
A sales clerk says, "A golden suede pouch will cost 50 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353900
You carefully inspect a golden suede pouch with sandruby-beaded drawstrings.

You estimate that a golden suede pouch with sandruby-beaded drawstrings can store a fairly small amount with enough space for any number of items.

You determine that you could wear the pouch, attaching it to your belt.  The pouch appears to serve some purpose.
>
[festshop]>exam #129353900
You take a closer look at a golden suede pouch with sandruby-beaded drawstrings.
>
[festshop]>get #129353899
A sales clerk says, "A deep blue brocade pouch will cost 50 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353899
You carefully inspect a deep blue brocade pouch with braided silver drawstrings.

You estimate that a deep blue brocade pouch with braided silver drawstrings can store a fairly small amount with enough space for any number of items.

You determine that you could wear the pouch, attaching it to your belt.  The pouch appears to serve some purpose.
>
[festshop]>exam #129353899
You take a closer look at a deep blue brocade pouch with braided silver drawstrings.
>
[festshop]>get #129353898
A sales clerk says, "A crimson leather pouch will cost 50 Ebon Gate seashells to purchase."
>
[festshop]>inspect #129353898
>
You carefully inspect a crimson leather pouch with black braided drawstrings.

You estimate that a crimson leather pouch with black braided drawstrings can store a fairly small amount with enough space for any number of items.

You determine that you could wear the pouch, attaching it to your belt.  The pouch appears to serve some purpose.
>
[festshop]>exam #129353898
You take a closer look at a crimson leather pouch with black braided drawstrings.
>
[festshop]>look under #-454867
There is nothing under there.
>
[festshop: Nothing found for container and adverb combination]
[festshop]>look behind #-454867
There is nothing behind there.
>
[festshop: Nothing found for container and adverb combination]
[festshop]>look in #129353896
There is nothing in there.
>
[festshop]>look on #129353896
There is nothing on there.
>
[festshop]>look under #129353896
There is nothing under there.
>
[festshop]>look behind #129353896
There is nothing behind there.
>
---- begin wiki output ----
<section begin=2017 />
<noinclude>==2017 Inventory==
</noinclude>
{{Festshop
|shopname=Faded and Desiccated
|look=Manually Populate This
|location=[Map Room #], Lich #XXXXX, go YYYYY
|fest=eg
|year=2017
}}
==={{{roomname-if multiroom}}}===
{{RoomDescription|
|roomname=Faded and Desiccated
|desc=The leather panels of a Tehir-styled pavilion hide the walls in this small building, complete with short strings of amber beads hanging from the roof.  A three-flamed oil lamp on a spindly brass stand fills the room with light and the scent of sandalwood, while a layer of furs covers whatever floor lies underfoot.  Near the oil lamp, a cedar display stand occupies the shop's center, a small table sits to one side, and an armor rack stands near the back wall.
|exits = out}}
{{sign|
|sign=     ~~  Barely made the boat, but here is what I brought! ~~
    Pouches are ONLY for gems, but are secure against thieving.
           ALL secure gem pouches can now be UNLOCKED.
        Unlocked pouches help you grab many gems at once!
                 Armor is said to be Al'Dur tribe wear.
              Amulet and talisman are crystal holders.
     Pendant is Unpoison, 10 charges, crumbles.  No recharge.
Tentacles are Neutralize Curse, 10 charges, crumbles.  No recharge.}}
<blockquote>
{{Container|
|container=On the table you see:}}
{| {{prettytable}}
| a copper ridgeweaver amulet tarnished to an ebon patina || ||neck-worn<br>functional|| 10
|-
| a copper selshis talisman || ||neck-worn<br>functional|| 10
|-
| a bracelet of dried qahzumar tentacles || ||wrist-worn<br>functional|| 5
|-
| a bronze qahzumar pendant with lapis tentacles || ||neck-worn<br>functional|| 5
|-
|}
{{Container|
|container=On the armor rack you see:}}
{| {{prettytable}}
| an ebon hounskull bearing sikuust mandibles as backswept horns || ||armor accessory; protects head<br>head-worn|| 20
|-
| a morduska hide back scabbard cross-wrapped with copper straps || Pocketed: Slightly small (16-19)<br>one item||shoulder/back-worn<br>functional|| 10
|-
| a sikuust chitin round shield with an ebon vultite frame || ||large [[shield]]|| 2500
|-
| some sikuust chitin vambraces || ||armor accessory; protects arms<br>arm-worn|| 5
|-
| some sikuust chitin greaves || ||armor accessory; protects legs<br>leg-worn|| 5
|-
|}
{{Container|
|container=On the cedar display stand you see:}}
{| {{prettytable}}
| a tanned yierka hide pouch with amber-beaded drawstrings || Pocketed: Fairly small (8-11)<br>any number of items||belt-worn<br>functional|| 50
|-
| a fine-linked ora chainmail pouch || Pocketed: Fairly small (8-11)<br>any number of items||belt-worn<br>functional|| 50
|-
| a golden suede pouch with sandruby-beaded drawstrings || Pocketed: Fairly small (8-11)<br>any number of items||belt-worn<br>functional|| 50
|-
| a deep blue brocade pouch with braided silver drawstrings || Pocketed: Fairly small (8-11)<br>any number of items||belt-worn<br>functional|| 50
|-
| a crimson leather pouch with black braided drawstrings || Pocketed: Fairly small (8-11)<br>any number of items||belt-worn<br>functional|| 50
|-
|}
</blockquote><section end=2017 />
---- end wiki output ----
---Insert code at the top of the shop page, just below any __TOC__---
---Don't forget to SEARCH each room and LOOK AT/IN/ON/UNDER/BEHIND all furniture for hidden entrances---
---The code above ===roomname=== should only be entered for the first room of the shop.---
---Replace roomname in that line with a short description of the current room (East Room, Office, Through Door, etc.)---
---If there are a lot of Entry or other similar room headers, make it unique (e.g. include initials or part of shopname)---
--- Lich: festshop has exited.

Return to the top of this page.