Shop & Town Extension for 3.5E / Pathfinder / 4E

So I've gotten some great feedback so far on my town conversion for Pathfinder. I took the advice, and cleaned up the code as well as made a 4E conversion as well.
Someone recommended a shop plugin for it, since towns have several shops, so now you can setup shops in both rulesets! You don't need the town.ext plugin to make the shop.ext plugin work, but if you use them together a town file will accept shop drops as a list so it's pretty handy!

Version 1.2 is posted below:
Changelog:
- Added 4th tab for Shoplist in Town
- Changed Main tab for both 3.5E / 4E to be more in line with what the cities require from each ruleset
- Changed icons
- Font sizing & location issues fixed

Update for Town & Shop version 1.3

Changelog:
Updated sidebar icons; made new sidebar icons for 4E to make them match
Added banner icons on the main windows
Added tab icons to clarify
Updated sorting to auto sort by name for all windows
Changed Shop inventory screen to show base cost and market price (price of the shop)
Changed NPC window to display CR / Level / Role and type (so that alignment is shown)

To Do - for 1.4 -
Update sorting for shop inventory and town NPC tab to sort by different columns
Add bestiary extension that pulls from module files and allows sorting of different columns i.e. level, type

Economy extension is also in the works to plug into town and shops.

Hi Bradmcadam,

Some feedback testing the extension in v2.9 beta (although I think some or all may apply to 2.8 as well). I tested mosly with v1.2, but I have just now re-confirmed these with 1.3:

General: Love it; very useful. Seems quite stable so far.

Scrolling - There is new scrolling in 2.9 (scrollbars), but neither the scrollbars nor the old scrolling control are appearing in the list windows.

Window Closing - Windows now have a "close" (X) button in the upper right, as well as the radial menu option to close them.

Lock/unlock: Detail windows for NPCs, etc., have a small lock icon in the lower left corner. The detail field content is read-only after initial entry unless that is toggled.

Town form, main tab

When using the Tab key to move from field to field, the Tabbing stops at the "Danger" field.

The "Disadvantages" field Tabs backwards to the "Danger" field (so, when currently on either "Qualities" or "Disadvantages", hitting Tab goes to "Danger").

Town form, NPCs tab

CR/Level column - In the "Notable NPCs by Name" list, this is not getting populated, although I did populate the CR field for each entry.

The "Drop NPC links on this frame to add" message can overlay entries on the list. This may be related to the scrolling.

Thanks very much, i'm finding it very useful, and expect to test it out more later tonight when I get home.

I'll have to take a look at this later. When it is fully complete, we could possibly throw it into the Store under 3.5E/Pathfinder and/or 4E if you were open to that. It might increase the visibility. We always have the option of including free or paid products in the store and could also link it in to the Update tool we're testing for 2.9.1 and beyond.

In general, I think useful utilities like this could do well in the store as fan-made DLC. The new table functionality in 3.5E and 4E present a lot of opportunity for charts, lookups, random tables, etc. With some scripting support, one could pretty much make interactive components for players to use. How cool would that be to stop by a town and then let each player individually go shopping with a fully automated NPC who runs the store and shares their available wares, orders or agrees to do commissioned work and who deducts money from the Player's sheet to pay for the goods? The whisper feature with a listener that parses the player whisper response could potentially be used to handle the interactions in the chat window without cluttering everyone else's chat windows.

This is very cool :)

Thanks for the awesome feedback! I only wrote this for 2.8 since that's what I'm currently DMing, so a lot of the features that are apparently broken for 2.9, I'm unaware of.

@Silveras:
- Scrolling: I decided to leave it out, since I never use those, but now that I have feedback I'll redesign the windows. On the same note, I'll clean up the boxes so the lists don't overlap on text, bad on my part, I never tested with a list greater than 5.
- Window closing: I'm not sure what's going on with 2.9, in 2.8 I have it setup to close the window with both the 'x' and the radial menu. I'll check on that.
- Main tab: I'll fix with 1.4, hopefully this weekend I'll have a release out.
- CR/Level column may have a different variable I'm not aware of in 2.9 I'll look into that as well

@ddavison:
Once it gets closer to a stable version and works for 2.9 let's talk about getting it on the store page. I'm having a lot of trouble with scripting for the moment, so I'm curious to see if 2.9 will fix any of my issues.

@bnason:
Thanks!

Quote:

---

Originally Posted by bradmcadam

Thanks for the awesome feedback! I only wrote this for 2.8 since that's what I'm currently DMing, so a lot of the features that are apparently broken for 2.9, I'm unaware of.

@Silveras:
- Scrolling: I decided to leave it out, since I never use those, but now that I have feedback I'll redesign the windows. On the same note, I'll clean up the boxes so the lists don't overlap on text, bad on my part, I never tested with a list greater than 5.
- Window closing: I'm not sure what's going on with 2.9, in 2.8 I have it setup to close the window with both the 'x' and the radial menu. I'll check on that.
- Main tab: I'll fix with 1.4, hopefully this weekend I'll have a release out.
- CR/Level column may have a different variable I'm not aware of in 2.9 I'll look into that as well

Thanks!

---

Yep, I mentioned the 2.9 stuff to be a heads-up in case some or all was working more consistently in 2.8. Overall, the functionality is mostly solid; I've had no issues other than those mentioned here, in putting in a fairly small town (15 or so NPCs, 5 shops). I have started on a bigger town now, so I will let you know if I find anything else while entering that.

It looks like the extensions break in the latest 2.9 update. An error dialog pops up with the same message twice:

Ruleset Error: No vertical anchor defined for 'tabs'
Ruleset Error: No vertical anchor defined for 'tabs'

This occurs when opening the City or Shop window or switching between tabs on them. The windows open and are usable.

No close button either (not gamebreaking at all, but just an FYI - have to use the radial to close the town/shop lists).

Real quick, if you could let me know which ruleset you're using when you post errors it would be helpful. I had to code them very differently.

On a side note, is 2.9 going to be released anytime soon? I'll judge how much work I put into that based on it's potential release date.

@Bradmcadam: Hi, all my testing is with the 3.5 ruleset, the Pathfinder variant.

I don't know the release date for 2.9. It is in beta, so "close" is a reasonable guess, but it could be days or weeks, depending on what people find as issues, I expect.

From what little I understand with 2.9, they're coding 3.5E more in line with 4E, so the 4E extension should be breaking down a lot less. I'll check it out though, thank you!

From the little bit I looked at it, they reorganized the directory and file structure so it might just be that the files you are overwriting are in a different location now.

In v2.9, the tabs just got an overhaul, so any extensions will need to be updated.

My estimate on v2.9 is in the next few weeks, barring any major issues. I'm going to announce the final push on the laboratory forums.

Cheers,
JPG

Update for Town & Shop version 1.4

Changelog:
- Now works with Fantasy Grounds 2.9! Whoo!
- Tabs, scroll bars, window close buttons all updated for 2.9 and should be visible
- Fixed the lists running over the text in the windows
- Fixed tab errors of going to the wrong next/previous box or not moving at all
- Changed windows in 4E to be more in line with 4E style

Future:
- Update sorting for shop inventory and town NPC tab to sort by different columns
- Scripting in 'random' town shops that pulls from the inventories of modules.

As always if there's stuff you want to see in my addons let me know, otherwise, Enjoy!

bradmcadam - this is a great extension which I plan to use extensively in my games - particularly the shops - very nice.

Given that I have the master assets for the 4E standard skin, I took the liberty of creating new versions of the extensions graphics assets so that they blend identically with the remaining skin elements.

I have attached a ZIP for containing all the new .pngs, should you wish to incorporate them. Note: you will have to amend the following into the towns extension.xml:

Code:

---

<icon name="button_towns" file="button_towns.png" />
<icon name="button_towns_down" file="button_towns_down.png" />

<framedef name="headertowns">
        <bitmap file="headertowns.png" />
        <middle rect="0,0,128,128" />
</framedef>

---

You will also have to amend the header frame in the town windowclass to use the new headerstown frame (defined above).

For Shops extension.xml, amend the following:

Code:

---

<icon name="button_shops" file="button_shops.png" />
<icon name="button_shops_down" file="button_shops_down.png" />

---

Great! I'll add that in to the next update. Thanks so much for making the addon even neater! Any requests while you're here?

This goes out to everyone as well, I've had a request to hide certain features from the players, so I'm working on hiding NPC data or displaying it differently. Is this a hot issue?

Testing the updated version now. v.2.9, Pathfinder option for 3.5

Appearance looks good. Scrollbars and close buttons appear and work as expected.

Does exporting a module not include the extension data? I made a module for the town that appears in my test campaign. When I activate the module in the main campaign, the Story entries and NPCs appear in the Story and NPC sections, but the Town and Shop entries do not. If I click on a link to a shop entry from the Story entries, a new shop is generated.

I noticed that there were no options to export the Town and Shop data when exporting the module.

I haven't played with exporting and importing yet, so that's probably why it doesn't work. I'm currently trying to get it to link back to the main shop list or npc list when you drag one in, having a bit of an issue but hopefully that may clear up the exporting issue as well.

Quote:

---

Originally Posted by bradmcadam

I haven't played with exporting and importing yet, so that's probably why it doesn't work. I'm currently trying to get it to link back to the main shop list or npc list when you drag one in, having a bit of an issue but hopefully that may clear up the exporting issue as well.

---

You'll need to code this into the export routine as it only supports specific FG SB items - encounters, images, npcs, battles (encounters), items, treasureparcels and tables. See /scripts/manager_export.lua in the 3.5E ruleset for the details of the registerExportNode commands used as standard.

I see... so it is making a copy instead of linking when you drag-n-drop a shop or NPC entry into the matching tab in the Town list entry, instead of making a link back to the original? I

Basically, yes. I'll update when I solve it.

So I'm trying to get the NPC list to only be links from the main list. Tried using <windowreferencefield> but I'm not even getting an icon unless I add in <class>npc</class> and then I get tons of scripting errors. Any ideas?

Code:

---

<windowclass name="town_npcsmall">
                        <sizelimits>
                                <minimum>
                                        <height>10</height>
                                </minimum>
                        </sizelimits>
                        <sheetdata>
               
                                <stringu name="name">
                                        <anchored>
                                                <top><anchor>top</anchor><offset>5</offset></top>
                                                <left><anchor>left</anchor><offset>0</offset></left>
                                                <size><width>100</width><height>20</height></size>
                                        </anchored>
                                        <tabtarget next="type" prev="levelrole" />
                                </stringu>
                               
                                <stringu name="type">
                                        <anchored>
                                                <top><anchor>top</anchor><offset>5</offset></top>
                                                <left><anchor>left</anchor><offset>102</offset></left>
                                                <right><anchor>right</anchor><offset>-90</offset></right>
                                        </anchored>
                                        <tabtarget next="levelrole" prev="name" />
                                </stringu>
                               
                                <stringu name="levelrole">
                                        <anchored>
                                                <top><anchor>top</anchor><offset>5</offset></top>
                                                <right><anchor>right</anchor><offset>-30</offset></right>
                                                <size><width>55</width><height>15</height></size>
                                        </anchored>
                                        <tabtarget next="name" prev="type" />
                                </stringu>
               
                                <!--<windowreferencecontrol>
                    <bounds>-20,5,20,20</bounds>
                                        <anchored>
                                                <top><anchor>top</anchor><offset>5</offset></top>
                                                <right><anchor>right</anchor><offset>-5</offset></right>
                                                <size><width>20</width><height>20</height></size>
                                        </anchored>
                                        <icon>
                                                <normal>button_openwindow</normal>
                                                <pressed>button_emptytarget</pressed>
                                        </icon>
                                        <class>npc</class>
                    <allowdrop />
                    <closetoggle />
                                        <description>
                                                <field>name</field>
                                        </description>
                    <script>
                        function onDrag(button, x, y, draginfo)
                            draginfo.setType("shortcut");
                                                       
                            local base = draginfo.createBaseData("shortcut");
                            base.setShortcutData(getValue());
                                               
                            draginfo.resetType();
                                               
                            return true;
                        end
                    </script>
                                </windowreferencecontrol>-->
               
                <windowreferencefield name="npc_link">
                    <bounds>-20,5,20,20</bounds>
                    <icon>
                        <normal>button_dragtarget</normal>
                    </icon>
                </windowreferencefield>
                        </sheetdata>
                </windowclass>

<windowclass name="town_npcs">
                        <sheetdata>
                               
                                <!-- NPC list -->
                                <stringcontrol>
                                        <anchored>
                                                <top><anchor>top</anchor><offset>5</offset></top>
                                                <left><anchor>left</anchor></left>
                                                <position>insidetop</position>
                                        </anchored>
                                        <center />
                                        <font>sheetlabel</font>
                                        <static>Notable NPCs by Name</static>
                                </stringcontrol>
                                <stringcontrol>
                                        <anchored>
                                                <bottom><anchor>bottom</anchor><offset>-10</offset></bottom>
                                                <left><anchor>left</anchor></left>
                                                <position>insidebottom</position>
                                        </anchored>
                                        <center />
                                        <font>chatitalicfont</font>
                                        <static>Drop NPC links on this frame to add</static>
                                </stringcontrol>
                               
                                <stringcontrol>
                                        <anchored>
                                                <top><anchor>top</anchor><offset>25</offset></top>
                                                <left><anchor>left</anchor><offset>25</offset></left>
                                        </anchored>
                                        <font>sheetlabelsmall</font>
                                        <static>Name</static>
                                </stringcontrol>
                                <stringcontrol>
                                        <anchored>
                                                <top><anchor>top</anchor><offset>25</offset></top>
                                                <left><anchor>left</anchor><offset>130</offset></left>
                                        </anchored>
                                        <font>sheetlabelsmall</font>
                                        <static>Type</static>
                                </stringcontrol>
                                <stringcontrol>
                                        <anchored>
                                                <top><anchor>top</anchor><offset>25</offset></top>
                                                <right><anchor>right</anchor><offset>-35</offset></right>
                                        </anchored>
                                        <font>sheetlabelsmall</font>
                                        <static>Level/Role</static>
                                </stringcontrol>
                               
                                <windowlist name="npclist">
                                        <anchored>
                                                <top><anchor>top</anchor><offset>40</offset></top>
                                                <left><anchor>left</anchor><offset>5</offset></left>
                        <bottom><anchor>bottom</anchor><offset>-25</offset></bottom>
                        <right><anchor>right</anchor><offset>-5</offset></right>
                                                <position>over</position>
                                        </anchored>
                                        <datasource>.npclist</datasource>
                                        <class>town_npcsmall</class>
                                        <acceptdrop>
                                                <class>npc</class>
                                                <field>*</field>
                                        </acceptdrop>
                                        <allowdelete />
                                        <script>
                                                function onSortCompare(w1, w2)
                                                        return w1.name.getValue() > w2.name.getValue();
                                                end
                                        </script>
                                </windowlist>
                <scrollbar>
                    <bounds>-17,40,20,-25</bounds>
                                        <target>npclist</target>
                                </scrollbar>
                        </sheetdata>
                </windowclass>

---

Silveras,

Exporting is on hold for the moment until I can figure out how to access the variable aExport in manager_export.lua from my extension files. I'm releasing another version tonight with some updated features including notes for GMs hidden from the players side if you wish to share the town data. Still running into the problem of the links copying over so I have a minor work-around going.

-Brad

Quote:

---

Originally Posted by bradmcadam

Silveras,

Exporting is on hold for the moment until I can figure out how to access the variable aExport in manager_export.lua from my extension files. I'm releasing another version tonight with some updated features including notes for GMs hidden from the players side if you wish to share the town data. Still running into the problem of the links copying over so I have a minor work-around going.

-Brad

---

Thanks for the heads-up!

Version 1.5 is out tonight with some updates.

Changelog:

- Big thanks to DrZeuss for the new icons, headers and sidebars!
- Added GM notes in the bottom of the main tab that only the GM can see so write bad things about your players and share the sheet knowing the joke's on them!
- Hid the NPC link for players so it's only accessible to the GM. All the players get to see is the name and job of the NPC in town
- Changed how the links work. This is still sort of buggy and this is my workaround in place. The links back to npcs or shops link back to the original npc or shop, but you have to drag it on to the link after the npc or shop is created. This means that you have to double drag, but once you do you can change all the info you want inside the npc or shop and it gets saved back to it's original. This also means you can change the name or job of the npc/shop and it won't affect it's link name or job. It was a request to be able to have a town guard be a frost giant in disguise. Remind me not to be in that campaign.
- Links in the shop inventory screen simply create their own items and do not reference back to the original. It seemed like a real hassle to me to have to double drag for such a huge list in a case that really won't matter.
- Various code cleanup, minimizing fixes and other such things you probably won't notice unless you caught it when it was wrong.

Quick note, because of my attempted workaround with the links back with npcs and shops, the addon is nicely broken. I'll do a quick 1.5.1 update to restore functionality back to the way it was where it copied in a new instance of npc or shop so you'll at least have access to the links and they won't disappear every time you close a window.

I love this extension, by the way! I started playin' around with it last weekend, and before I knew it; I'd spent hours creating all kinds of shops.

Thank you for your contribution to the community! Very cool, very helpful.

Thanks Torgaard! I really appreciate it. It makes working on this stuff easier and more fun when I know people are making good use of it.

Here's the latest - Version 1.5.1:

Changelog:
- Reverted back to previous <windowreferencecontrol> configuration so links stopped dissapearing. This means they still copy new instances of NPCs and Shops, but at least it's doable.

Hey Brad, I just wanted to mention one thing.. it looks like by including the version number in the extension name, each version appears as a new extension. That means there's no way to do an "in-place" upgrade by replacing the old version with the new version. As a result, each time there's a new version, you have to disable the old extension and enable the new in the Load Campaign screen.

Yeah, I actually did that on purpose so that you were aware of what version you were using. I can always change it, since it's primarily for my use with debugging.

brad - hovering your mouse over the extension name in the extension lists window will reveal information including version numbers. So there is no real need to include version numbers in the title of the extension.

Just make sure you populate the version tag in the base root properties of the extension.

Quote:

---

Originally Posted by bradmcadam

Yeah, I actually did that on purpose so that you were aware of what version you were using. I can always change it, since it's primarily for my use with debugging.

---

I don't know if you've done this already - but a few extensions write a message to the chat window on startup - include the version in such a message and GMs will know what they're using! :)

The Alt Wound Color extension I just wrote for 4E does this. Its a tiny extension with two scrips - one of which is the output message to chat, if you want to see some sample code.

Awesome! I'll look into that. I'd be happy with the mouseover feature, but if what I'm hearing from you guys is that you'ld like the chat window output as well it will be done!

Quote:

---

Originally Posted by bradmcadam

Awesome! I'll look into that. I'd be happy with the mouseover feature, but if what I'm hearing from you guys is that you'ld like the chat window output as well it will be done!

---

One of the advantages of the chat window output is that you can ask someone who is having an issue to post a screenshot of the chat window in startup and you can see the actual version they are running (rather than the version they "think" they are running) - and other running extensions (if they write info to chat).

Also with FG 2.9 you can now copy the chat text to the clipboard so you can have them paste it into a message to simplify it.

I don't know if its possible, but this would be a nice feature you may want to consider .
i would very much like to be able to drag towns onto images, so that my world map could have little icons for different towns allowing my players to click on them when i provide them with new maps. this way they could discover new towns by looking at maps or perhaps be linked to town maps without having to scroll through lists of towns and villages or other images to find them.

James, you might try creating a story entry for the town and then have it linked to the town entry. You can link anything to a story entry - map, town, npc, etc. It would also allow you to store other useful information regarding the town as well.

Once you've done this, you can hold down CTRL and drag and drop the story entry to your overland map. This will place a push-pin directly on the map which links back to the story and then to the town. These are hidden on the map until you hold down the CTRL key again.

Quote:

---

Originally Posted by ddavison

James, you might try creating a story entry for the town and then have it linked to the town entry. You can link anything to a story entry - map, town, npc, etc. It would also allow you to store other useful information regarding the town as well.

Once you've done this, you can hold down CTRL and drag and drop the story entry to your overland map. This will place a push-pin directly on the map which links back to the story and then to the town. These are hidden on the map until you hold down the CTRL key again.

---

i want aware you could do this that's quite useful,thank you.
another question about something i noticed the other day, when i was exporting a test version of my adventure module found that you cant seem to export town and shop data? i use modules so i can hide away large amounts of unnecessary data, as most of my campaigns are quite long, so is there anyway around this?