Vinconomy - A Vintage Story Economy Mod

Purpose

The goal of this was to sink or swim trying to get started into modding Vintage Story. I did not see any up-to-date trade mods, and the ones currently available either do not work on the most recent version of the game, or do not fit my tastes / needs. I wanted a trading mod that is useful, aesthetic, configurable to suit a more widespread use-case, and one that does not require any sort of commands in chat to function.

Player Shops - Selling

The system works via Shops and Stalls. The player can place various types of Stalls to which may be linked to a Shop Register. Any goods provided at the stalls will be paid for on-site, and any proceeds will be stored directly in the Register. Each stall may have one or more different types of goods, and each stall must be part of a shop in order to function.

To open a shop, you will need one or more Stalls and a Register. First place the Register in a location where you will often be checking for payment. There is currently no limit on distance to the stalls themselves. From there, you can open the interface and set the name of your shop - it can be anything you like. Any payment for items will end up here. Be sure to clear out your Register occasionally, as you cannot make a sale if you do not have enough space for payment.

Next for each Stall you wish to place, place it down in a suitable location to sell your goods. Most stalls have 4 stock slots, with 9 slots for each stall, for a total of 36 total stacks of goods. As an owner, you can Sneak-Rightclick to add an item to that Stall Slot, or Sneak-Sprint-Rightclick to add multiple. Each slot can only hold items of the same type, so you cannot put Turnips and Parsnips in the same Stall Slot, for example. If you wish to manage multiple slots without having to exit and right click on a different stall slot, you can switch slots with the arrow buttons on the top right. You may also change the Items Per Purchase amount in order to sell more than one item for each sale. The Currency slot below the Price label can take any item you see fit for payment. Note that you do not need to sacrifice the item for payment like in other mods - The slot will clone the itemstack when you click on it. You can also click on the price item slot to clear it.

If you've configured everything correctly, once a player tries to access your stall, they will be shown the price they need to pay, as well as the product they will recieve. They can increase the number of purchases by adjusting the Quantity option on the menu before pressing the "Deal" button

Admin Shop Info

If you have the "Gamemode" permission, you can also set this stall as an Admin Shop which will allow you to sell infinite amounts of items without having to restock the stall. If you wish to still collect payment for these purchases - for example to use the currency again for situations such as limited circulation - you can set the shop as you would with a normal Stall. If you wish for the payment items to simply be deleted, leave the Shop set to "None"

 

Things to note:

• The stall will not function if there is no price set for the item
• The stall will not function if there is no Shop set for the stall (Unless it is an Admin Shop)

Player Shops - Buying

Purchases can be made simply by having the payment in your hand and Sneak-Rightclicking on the desired slot to make a purchase. Sprint-Sneak-Rightclicking will purchas items 5 at a time. Note that this is multiplied by the "Items Per Purchase" modifier, so if a stall sells 10 Turnips per gear, you would be purchasing 50 turnips. You may also simply right click the stall in order to see via a GUI what is for sale and for how much. you can then initiate the trade by clicking the "Deal" button.

Register Configuration

The register is broken up into different tabs for convienence and organization. The first tab quite simply holds all the items that are collected from purchases made at your shop. Any currency used will be inserted into the Currency slots, and coupons used will be inserted into the dedicated Coupons slots

 

In order to set up a Trade Pass or add other players for access to your shops, go to the Permissions tab. Note that if you click the Stall Access checkbox at the bottom, any players granted Register access will also be able to access your stalls for that shop too.

 

On the configuration page, you can rename your shop, as well as a Short Description that will show up in the Ledger's Shop List, as well as a longer description that will show up when viewing that specific shop. Note that VHTML is supported on both of these fields.

You may also provide a Discord Webhook so that any time someone purchases items from your shop, a notification message will appear via the webhook.

 

Lastly, is the Waypoint page. You may set a custom waypoint to be displayed to all players on the server in order to advertize your shop and its location. If the waypoint is visible to players, the location will also show up in the Ledger, along with a link to view the location directly in the map.

Ledger

The Ledger can be used in order to view all sales for a given Month/Year. Vinconomy automatically records the transactions, and a Ledger does not need to be in the register or even crafted at the time of sale. Years worth of sales may pass before you finally get around to needing a Ledger, but fret not! All your previous sales will still show up once you craft and link it to your shop. The ledger will group entries by the person purchasing items and its type. Multiple/repeated sales will all be condensed into a single line if the Product and Currency used remains the same.

 

The Ledger works in two ways:

• If  you are an Admin and in Creative mode, an Unlinked Ledger will show all Admin Stall trades (Stalls that do not have a respective Shop and the "Admin Stall" box is checked on the GUI).
• If you are normal player, you must "bind" the ledger to a specific shop, and the ledger will show trades only for that shop. Note that this is independent of who opens it, so if you give the ledger to another player, they will be able to see the sales for as long as they have the Ledger item.

 

 

 

Catalog

The Catalog lists all shops on the server that are currently active. Their Name and Owner is always displayed, but the location only appears with a Map Link if the waypoint is broadcasted. Clicking this link will automatically open the map and focus on that map location - No need to manually navigate to those coordinates!

 

 

Clicking any of the respective "View" buttons will open the shop's inventory, as well as show its Long Description. This way you can see at a glance which items are currently for sale at that shop. 

Meal Stall

The Meal Stall is useful if you want to sell food to players without needing to sell the food container along with it. Unlike most Stalls, you cannot add/remove contents directly from inside the GUI. Instead, you must transfer contents with containers like Bowls, Cooking Pots, and Crocks. For convienence, the GUI shows you the exact recipe used for that slot. Each stall slot can support up to 64 Servings.

Coupon Cutter

The Coupon Cutter can create bonuses for purches for a specific selection of shops, or all of them owned by you. These bonuses can be in the form of Bonus Product or Price Discounts. Each coupon needs Parchment to craft, but produces 16 Coupons at a time.

A Coupon can be given a name to help distinguish what the coupon is for. You may also select the shops the coupon is honored by, or leave it blank to allow all shops owned by you to honor the coupon.

You may also specify an item Whitelist/Blacklist of items that the coupon applies to, up to 10 items. Leaving this list blank means it will work for any item. In our example above, we have a Whitelist containing a selection of Bread - so this copuon only applies for those specific bread types and would not apply to other food such as pies.

Coupons can offer bonuses as a flat-rate "Unit" basis, or a percentage.

• Unit - The bonus or discount is explicitly supplied. As an example, a 5 Unit Price Discount would subtract 5 units from the cost of the item. E.g. an item being sold for 15 Rusty Gears with a 5 Unit Discount would only cost 10 Rusty Gears
• Percentage - The bonus or discount is proportional to the cost of the item, with the result rounded down to the nearest whole number. As an example an item being sold for 15 Rusty Gears with a 10% Discount would only cost 14 Rusty Gears (15 x 0.1 = 1.5, rounded down = 1 Rusty Gear savings)

 

Note that the system will automatically handle preserving coupons that do not actually offer a discount. This means that if you used a 10% Discount coupon on something being sold for 5 Rusty Gears, the coupon would not be used as it did not actually save you any money (5 x 0.1 = 0.5 Rounded Down = 0 Rusty Gear Savings)

Teller Machine

The Teller Machine is your way of allowing players to exchange currencies with you, provided you have enough stock in your register for the trade. For servers that utilize multiple forms of currency with mods such as Coinage, you can allow your players to freely exchange for the exact currency type required. 

Note that these trades are bidirectional and cannot be restricted - you cannot offer a trade where the player pays 1 Gold Coin and receives 10 Silver Coins, but then ask the player to pay for 15 Silver Coins for 1 Gold Coin in return. Teller Machines operate on equivalence - If something cost 1 US Dollar, you can pay for it with 4 Quarters, 10 Dimes, 20 Nickels, 100 Pennies, etc. I am not required to have a 1 US Dollar Bill on me to buy the item - It works the same way here.

 

In the example above, I can exchange 12 Rusty Gears for a Temporal Gear, or exchange 1 Temporal Gear for 12 Rusty Gears. To change the direction, simply press the "Reverse Trade" button in the middle, which will enable the other "Deal" button.