Lich:Festshop script
Jump to navigation
Jump to search
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.
The latest change (September 30, 2017) was made by VANKRASN39 to add two parameters so that the festshop template can be used at all fests, and to guess the seashell 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 --slow 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.
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.
Due to the regular missing of items, after speaking with PFLATS, I am recommending that everyone run the script in --slow mode until the next update. It doesn't run that slow, and gives more than a half second for the game to respond. If it hangs, then try running regular mode.
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.)---
Known Errors
- The script is known to miss some items, especially if there are a lot of items in a room. A quick visual comparison should be made of number of items in a container and those listed in the output code.
- 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 in the Entry room.
>;festshop
--- Lich: festshop active.
[festshop]>look
[Silver Bells]
White silk walls surround this small room, made cozy by the small wood stove burning in the corner. A rack of clothing and several jewelry boxes house wares that sparkle in the firelight. A belled curtain leads to another room, the strands tinkling softly with the small breezes that enter through the tent's open flap. You also see a pudgy frosting-covered dormouse and the Maags disk.
Also here: Sir Cryheart, Maags
Obvious exits: out
[festshop]>read #1987228
There is nothing there to read.
[festshop]>read #2072542
Your attempt fails, as the disk quietly evades you.
[festshop]>read #-372095
There is nothing there to read.
[festshop]>read #-372094
There is nothing there to read.
[festshop]>read #-372093
There is nothing there to read.
[festshop: System Thinks this is an object!! - -372095]
[festshop]>look in #-372095
There is nothing in there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look on #-372095
On the rack you see a flared red suede skirt, a fur-hemmed white skirt, a patchwork grey and red skirt, a fitted grey wool skirt, a vivid red cotton blouse, a fur-hemmed white silk bodice, a soft grey linen shirt, an open-necked white cotton shirt, a thinly woven wool jacket, a tailored fox fur longcoat, a hooded grey fur cloak and a fur-trimmed white velvet cloak.
[festshop: Plain old container found!]
[festshop]>get #1297910
A sales clerk steps over to you and says, "Ah, a fine choice madam. A flared red suede skirt sells for 15000 silvers. You can BUY the red suede skirt if you like."
[festshop]>inspect #1297910
You carefully inspect a flared red suede skirt with tiny silver bell buttons.
You determine that you could wear the skirt on your legs. The skirt appears to serve some purpose.
[festshop]>exam #1297910
You take a closer look at a flared red suede skirt with tiny silver bell buttons.
You see nothing unusual.
[festshop]>get #1297907
A sales clerk steps over to you and says, "Ah, a fine choice madam. A fur-hemmed white skirt sells for 15000 silvers. You can BUY the white skirt if you like."
[festshop]>inspect #1297907
You carefully inspect a fur-hemmed white skirt edged with tiny silver bells.
You determine that you could wear the skirt on your legs. The skirt appears to serve some purpose.
[festshop]>exam #1297907
You take a closer look at a fur-hemmed white skirt edged with tiny silver bells.
You see nothing unusual.
[festshop]>get #1297904
A sales clerk steps over to you and says, "Ah, a fine choice madam. A patchwork grey and red skirt sells for 15000 silvers. You can BUY the grey and red skirt if you like."
[festshop]>inspect #1297904
You carefully inspect a patchwork grey and red skirt with tiny silver bell buttons.
You determine that you could wear the skirt on your legs. The skirt appears to serve some purpose.
[festshop]>exam #1297904
You take a closer look at a patchwork grey and red skirt with tiny silver bell buttons.
You see nothing unusual.
[festshop]>get #1297901
A sales clerk steps over to you and says, "Ah, a fine choice madam. A fitted grey wool skirt sells for 15000 silvers. You can BUY the grey wool skirt if you like."
[festshop]>inspect #1297901
You carefully inspect a fitted grey wool skirt sporting a silver bell-lined slit.
You determine that you could wear the skirt on your legs. The skirt appears to serve some purpose.
[festshop]>exam #1297901
You take a closer look at a fitted grey wool skirt sporting a silver bell-lined slit.
You see nothing unusual.
[festshop]>get #1297898
A sales clerk steps over to you and says, "Ah, a fine choice madam. A vivid red cotton blouse sells for 15000 silvers. You can BUY the red cotton blouse if you like."
[festshop]>inspect #1297898
You carefully inspect a vivid red cotton blouse with silver bell buttons.
You determine that you could wear the blouse around your chest. The blouse appears to serve some purpose.
[festshop]>exam #1297898
You take a closer look at a vivid red cotton blouse with silver bell buttons.
You see nothing unusual.
[festshop]>get #1297895
A sales clerk steps over to you and says, "Ah, a fine choice madam. A fur-hemmed white silk bodice sells for 15000 silvers. You can BUY the white silk bodice if you like."
[festshop]>inspect #1297895
You carefully inspect a fur-hemmed white silk bodice with bell-tipped back laces.
You determine that you could wear the bodice around your chest. The bodice appears to serve some purpose.
[festshop]>exam #1297895
You take a closer look at a fur-hemmed white silk bodice with bell-tipped back laces.
You see nothing unusual.
[festshop]>get #1297892
A sales clerk steps over to you and says, "Ah, a fine choice madam. A soft grey linen shirt sells for 15000 silvers. You can BUY the grey linen shirt if you like."
[festshop]>inspect #1297892
You carefully inspect a soft grey linen shirt with silver bell cufflinks.
You determine that you could wear the shirt around your chest. The shirt appears to serve some purpose.
[festshop]>exam #1297892
You take a closer look at a soft grey linen shirt with silver bell cufflinks.
You see nothing unusual.
[festshop]>get #1297889
A sales clerk steps over to you and says, "Ah, a fine choice madam. An open-necked white cotton shirt sells for 15000 silvers. You can BUY the white cotton shirt if you like."
[festshop]>inspect #1297889
You carefully inspect an open-necked white cotton shirt with silver bell cufflinks.
You determine that you could wear the shirt around your chest. The shirt appears to serve some purpose.
[festshop]>exam #1297889
[festshop]>get #1297886
You take a closer look at an open-necked white cotton shirt with silver bell cufflinks.
You see nothing unusual.
A sales clerk steps over to you and says, "Ah, a fine choice madam. A thinly woven wool jacket sells for 20000 silvers. You can BUY the woven wool jacket if you like."
[festshop]>inspect #1297886
You carefully inspect a thinly woven wool jacket with silver bell buttons.
You estimate that a thinly woven wool jacket with silver bell buttons can store a significant amount with enough space for any number of items.
You determine that you could wear the jacket, hanging it from your shoulders. The jacket appears to serve some purpose.
[festshop]>exam #1297886
You take a closer look at a thinly woven wool jacket with silver bell buttons.
You see nothing unusual.
[festshop]>get #1297883
A sales clerk steps over to you and says, "Ah, a fine choice madam. A tailored fox fur longcoat sells for 20000 silvers. You can BUY the fox fur longcoat if you like."
[festshop]>inspect #1297883
You carefully inspect a tailored fox fur longcoat with a silver bell-trimmed hem.
You estimate that a tailored fox fur longcoat with a silver bell-trimmed hem can store a significant amount with enough space for any number of items.
You determine that you could wear the longcoat, hanging it from your shoulders. The longcoat appears to serve some purpose.
[festshop]>exam #1297883
You take a closer look at a tailored fox fur longcoat with a silver bell-trimmed hem.
You see nothing unusual.
[festshop]>get #1297880
A sales clerk steps over to you and says, "Ah, a fine choice madam. A hooded grey fur cloak sells for 20000 silvers. You can BUY the grey fur cloak if you like."
[festshop]>inspect #1297880
You carefully inspect a deeply hooded grey fur cloak with a silver bell clasp.
You estimate that a deeply hooded grey fur cloak with a silver bell clasp can store a significant amount with enough space for any number of items.
You determine that you could wear the cloak, hanging it from your shoulders. The cloak appears to serve some purpose.
[festshop]>exam #1297880
You take a closer look at a deeply hooded grey fur cloak with a silver bell clasp.
You see nothing unusual.
[festshop]>get #1297877
A sales clerk steps over to you and says, "Ah, a fine choice madam. A fur-trimmed white velvet cloak sells for 20000 silvers. You can BUY the white velvet cloak if you like."
[festshop]>inspect #1297877
You carefully inspect a fur-trimmed white velvet cloak with a bell-lined hood.
You estimate that a fur-trimmed white velvet cloak with a bell-lined hood can store a significant amount with enough space for any number of items.
You determine that you could wear the cloak, hanging it from your shoulders. The cloak appears to serve some purpose.
[festshop]>exam #1297877
You take a closer look at a fur-trimmed white velvet cloak with a bell-lined hood.
You see nothing unusual.
[festshop]>look under #-372095
There is nothing under there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look behind #-372095
There is nothing behind there.
[festshop: Nothing found for container and adverb combination]
[festshop: System Thinks this is an object!! - -372094]
[festshop]>look in #-372094
In the jewelry boxes you see a delicate silver anklet, a tiered platinum chain anklet, a silver chain wristlet, a thick platinum cuff, a tiered silver necklace, a platinum back lariat necklace, a narrow silver ring, a slender green jade band, a tiered rose gold hip-chain and a delicate silver hip-chain.
[festshop: Plain old container found!]
[festshop]>get #1129699
A sales clerk steps over to you and says, "Ah, a fine choice madam. A delicate silver anklet sells for 10000 silvers. You can BUY the silver anklet if you like."
[festshop]>inspect #1129699
You carefully inspect a delicate silver anklet dangling heart-shaped ruby bells.
You determine that you could wear the anklet on your ankle.
[festshop]>exam #1129699
You take a closer look at a delicate silver anklet dangling heart-shaped ruby bells.
You see nothing unusual.
[festshop]>get #1129696
[festshop]>inspect #1129696
A sales clerk steps over to you and says, "Ah, a fine choice madam. A tiered platinum chain anklet sells for 10000 silvers. You can BUY the platinum chain anklet if you like."
You carefully inspect a tiered platinum chain anklet sporting tiny silver bells.
You determine that you could wear the anklet on your ankle.
[festshop]>exam #1129696
You take a closer look at a tiered platinum chain anklet sporting tiny silver bells.
You see nothing unusual.
[festshop]>get #1129693
A sales clerk steps over to you and says, "Ah, a fine choice madam. A silver chain wristlet sells for 10000 silvers. You can BUY the chain wristlet if you like."
[festshop]>inspect #1129693
You carefully inspect a silver chain wristlet adorned with tiny ruby bells.
You determine that you could wear the wristlet around your wrist.
[festshop]>exam #1129693
You take a closer look at a silver chain wristlet adorned with tiny ruby bells.
You see nothing unusual.
[festshop]>get #1129690
A sales clerk steps over to you and says, "Ah, a fine choice madam. A thick platinum cuff sells for 10000 silvers. You can BUY the platinum cuff if you like."
[festshop]>inspect #1129690
You carefully inspect a thick platinum cuff set with rows of tiny bells.
You determine that you could wear the cuff around your wrist.
[festshop]>exam #1129690
You take a closer look at a thick platinum cuff set with rows of tiny bells.
You see nothing unusual.
[festshop]>get #1129687
A sales clerk steps over to you and says, "Ah, a fine choice madam. A tiered silver necklace sells for 10000 silvers. You can BUY the silver necklace if you like."
[festshop]>inspect #1129687
You carefully inspect a tiered silver necklace sprinkled with tiny ebon bells.
You determine that you could wear the necklace around your neck.
[festshop]>exam #1129687
You take a closer look at a tiered silver necklace sprinkled with tiny ebon bells.
You see nothing unusual.
[festshop]>get #1129684
A sales clerk steps over to you and says, "Ah, a fine choice madam. A platinum back lariat necklace sells for 10000 silvers. You can BUY the back lariat necklace if you like."
[festshop]>inspect #1129684
You carefully inspect a belled platinum back lariat necklace.
You determine that you could wear the necklace around your neck.
[festshop]>exam #1129684
You take a closer look at a belled platinum back lariat necklace.
You see nothing unusual.
[festshop]>get #1129681
A sales clerk steps over to you and says, "Ah, a fine choice madam. A narrow silver ring sells for 10000 silvers. You can BUY the silver ring if you like."
[festshop]>inspect #1129681
You carefully inspect a narrow silver ring sporting a cluster of ruby bells.
You determine that you could wear the ring around your finger.
[festshop]>exam #1129681
You take a closer look at a narrow silver ring sporting a cluster of ruby bells.
You see nothing unusual.
[festshop]>get #1129678
A sales clerk steps over to you and says, "Ah, a fine choice madam. A slender green jade band sells for 10000 silvers. You can BUY the green jade band if you like."
[festshop]>inspect #1129678
You carefully inspect a slender green jade band set with a cluster of silver bells.
You determine that you could wear the band around your finger.
[festshop]>exam #1129678
You take a closer look at a slender green jade band set with a cluster of silver bells.
You see nothing unusual.
[festshop]>get #1129675
A sales clerk steps over to you and says, "Ah, a fine choice madam. A tiered rose gold hip-chain sells for 10000 silvers. You can BUY the rose gold hip-chain if you like."
[festshop]>inspect #1129675
Maags giggles.
You carefully inspect a tiered rose gold hip-chain sporting tiny diamond bells.
You determine that you could wear the hip-chain around your waist.
[festshop]>exam #1129675
You take a closer look at a tiered rose gold hip-chain sporting tiny diamond bells.
You see nothing unusual.
[festshop]>get #1129672
A sales clerk steps over to you and says, "Ah, a fine choice madam. A delicate silver hip-chain sells for 10000 silvers. You can BUY the silver hip-chain if you like."
[festshop]>inspect #1129672
You carefully inspect a delicate silver hip-chain dangling tiny star-shaped bells.
You determine that you could wear the hip-chain around your waist.
[festshop]>exam #1129672
You take a closer look at a delicate silver hip-chain dangling tiny star-shaped bells.
You see nothing unusual.
[festshop]>look on #-372094
There is nothing on there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look under #-372094
There is nothing under there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look behind #-372094
There is nothing behind there.
[festshop: Nothing found for container and adverb combination]
[festshop: System Thinks this is an object!! - -372093]
[festshop]>look in #-372093
There is nothing in there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look on #-372093
There is nothing on there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look under #-372093
There is nothing under there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look behind #-372093
There is nothing behind there.
[festshop: Nothing found for container and adverb combination]
[festshop]>look in #1987228
You get the feeling the pudgy dormouse won't let you take a closer look inside of it.
[festshop]>look on #1987228
Except for possibly a few fleas, you see nothing but the pudgy dormouse's fur.
[festshop]>look under #1987228
You and the pudgy dormouse really aren't good enough friends for you to be attempting that.
[festshop]>look behind #1987228
Nope, the pudgy dormouse hasn't left any presents for you... yet.
---- begin wiki output ----
{{Festshop|
|shopname=Silver Bells
|look=Manually Populate This
|location=Lich #XXXXX, go YYYYY
}}
==={{{roomname}}}===
{{RoomDescription|
|roomname=Silver Bells
|desc=White silk walls surround this small room, made cozy by the small wood stove burning in the corner. A rack of clothing and several jewelry boxes house wares that sparkle in the firelight. A belled curtain leads to another room, the strands tinkling softly with the small breezes that enter through the tent's open flap.
|exits = out}}
<blockquote>
{{Container|
|container=On the rack you see:}}
{| {{prettytable}}
| a flared red suede skirt with tiny silver bell buttons || ||leg-worn<br>functional|| 15000
|-
| a fur-hemmed white skirt edged with tiny silver bells || ||leg-worn<br>functional|| 15000
|-
| a patchwork grey and red skirt with tiny silver bell buttons || ||leg-worn<br>functional|| 15000
|-
| a fitted grey wool skirt sporting a silver bell-lined slit || ||leg-worn<br>functional|| 15000
|-
| a vivid red cotton blouse with silver bell buttons || ||chest-worn<br>functional|| 15000
|-
| a fur-hemmed white silk bodice with bell-tipped back laces || ||chest-worn<br>functional|| 15000
|-
| a soft grey linen shirt with silver bell cufflinks || ||chest-worn<br>functional|| 15000
|-
| an open-necked white cotton shirt with silver bell cufflinks || ||chest-worn<br>functional|| 15000
|-
| a thinly woven wool jacket with silver bell buttons || Pocketed: Significant (100-119)<br>any number of items||cloak-worn<br>functional|| 20000
|-
| a tailored fox fur longcoat with a silver bell-trimmed hem || Pocketed: Significant (100-119)<br>any number of items||cloak-worn<br>functional|| 20000
|-
| a deeply hooded grey fur cloak with a silver bell clasp || Pocketed: Significant (100-119)<br>any number of items||cloak-worn<br>functional|| 20000
|-
| a fur-trimmed white velvet cloak with a bell-lined hood || Pocketed: Significant (100-119)<br>any number of items||cloak-worn<br>functional|| 20000
|-
|}
{{Container|
|container=In the several jewelry boxes you see:}}
{| {{prettytable}}
| a delicate silver anklet dangling heart-shaped ruby bells || ||ankle-worn|| 10000
|-
| a silver chain wristlet adorned with tiny ruby bells || ||wrist-worn|| 10000
|-
| a thick platinum cuff set with rows of tiny bells || ||wrist-worn|| 10000
|-
| a tiered silver necklace sprinkled with tiny ebon bells || ||neck-worn|| 10000
|-
| a belled platinum back lariat necklace || ||neck-worn|| 10000
|-
| a narrow silver ring sporting a cluster of ruby bells || ||finger-worn|| 10000
|-
| a slender green jade band set with a cluster of silver bells || ||finger-worn|| 10000
|-
| a tiered rose gold hip-chain sporting tiny diamond bells || ||waist-worn|| 10000
|-
| a delicate silver hip-chain dangling tiny star-shaped bells || ||waist-worn|| 10000
|-
|}
</blockquote>
---- 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.)---
--- Lich: festshop has exited.
EG 2017
This year the festshop template has been updated to be used for all festivals with parsing categories where needed, this is done through the fest and year parameters, which should be included once per shop underneath the manually populated information (it will automatically output).
All of the information between, but not including the bolded lines, should be pasted into the first room. The second room, and additional rooms after that, should include only ===Room Name=== on down, and should be pasted before the </blockquote><section end=2017 />.
Sample Shop Code
---- begin wiki output ----
<section begin=2017 />
<noinclude>==2017 Inventory==
</noinclude>
{{festshop
|shopname=manually populate
|look=manually populate
|location=[Map Room #], Lich #XXXXX, go YYYYY (manually populate)
|fest=eg
|year=2017
}}
===Room Name (if multi-room)===
{{RoomDescription}}
{{sign|sign=IT'S A SIGN!}}
<blockquote>
{{container|container=In a container:}}
{| {{prettytable}}
|table
|-
|listing
|-
|stuff
|}
{{container|container=In another container:}}
{| {{prettytable}}
|table 2
|-
|listing
|-
|stuff
|}</blockquote>
===Room 2 Name (if multi-room)===
{{RoomDescription}}
{{sign|sign=IT'S A SIGN!}}
<blockquote>
{{container|container=In a container:}}
{| {{prettytable}}
|table
|-
|listing
|-
|stuff
|}<!--paste third room, etc. on the next line below, if applicable, here.--></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 headers, make it unique (include part or initials of shopname)---
--- Lich: festshop has exited.
--- Lich: sorter active.