Setup Guide

0) Information before installing

The mod PotionCore currently breaks the entitiy interaction event on network traffic level (where sponge tries to track it). Please check if your modpack is using that.

Pixelmon and other total conversions might mess with mob placement and replacement. Please ensure such features are disabled in the mods config before they’re spammed on your world. You should probably know the details for this command in case something goes wrong.

1) Install dependencies

Install some economy plugin - TotalEconomy is a pretty popular one. You might want to set up the default currency, paydays and other options.

Install LangSwitch.
You do not have to configure this plugin.

Install MegaMenus.
You do not have to configure this plugin.

2) Install VillagerShops

There’s two ways to install it:

a) Download the zip release from GitHub

Extract the zip and upload both, the mods and config folder, to your server.

b) Download the jar release from here

Upload it to your server like normal and start the server once for configurations to generate.
Now go into /vshop/settings.conf and enable the auto downloader before reloading the config with /vshop reload. Once villager shop tells you to restart the server you can also load the translations with /sponge plugin langswitch reload

3) About auto download

Translations will not automatically update. This is to prevent the plugin from replacing customized translations.
If you want to update the translations after a plugin update through ore you have to delete the translations (all) from /config/vshop/Lang/. After this you can call /vshop reload and /sponge plugin langswitch reload to download and load the new translations.

4) Configuration options for compatibility

Pixelmon

What’s the Problem: Pixelmon by default is replacing Villagers with trainers. While this is all fine in most cases, this will make VillagerShops loose track of the entity. As a reaction VillagerShop spawns a new villager, that gets converted the next tick.
Solutions: You can either not use any Villagers as shops (other animals / mobs should be fine), or go into your Pixelmon config and disable villager conversion.

Minecraft Comes Alive

What’s the Problem: Pretty much the same as with Pixelmon
Solution: Go into the config and turn of overwriting original villagers (general section)

Inventory Tweaks

What’s the Problem: It’s messing with mouse-click events, partially using custom events when installed on the server. These custom events are not recognised by the menus and might trigger anti-glitch systems.
Solution: Check if you can remove the mod from the server. Inventory Tweaks works perfectly fine as client only mod, causing it to use vanilla events

RLCraft, Engineer’s Life, Roguelike Adventures & Dungeons, Life in the Village (Mod: PotionCore)

What’s the Problem: For certain potions PotionCore implements custom interaction events, to extend reach. From what I could gather this method is outdated, but the mod does not seem to get updated regularly. The result is Sponge not being able to detect or block interaction events at all!
Solution: If you’re in charge of the modpack, you could try to remove it. Otherwise edit both PotionCore configs in you server and clients /config/ folder, and set B:"Fix Reach"=false

Quark (Mod)

What’s the Problem: After interacting with a shop once, it won’t open again. This seems to be caused by using the Improved Sign Edit function of Quark (reported here).
Solution: The simplest solution seems to disable that feature in the Quark configuration.