WorldShops allows users with set permissions to manage automated vending machines around the map. Buildings which house vending machines will not decay or take any damage until the shops are destroyed, disabled, or wiped. These shops save on unload, so of course if the server doesn't unload WorldShops before exiting or does not use quit, your shops will not save.
Customizing and configuring the shops can be done via JSON or in game commands, and offers control of the sell orders, skins, and names of the shops. Configurations can be applied to multiple shops
Most of the commands use a building hammer or other weapons to tell location or vending machine to run the command on.
Default settings are included to demonstrate the settings file and nothing more. To do anything with this mod you need to adjust the settings.
Possible additions:
Customizing and configuring the shops can be done via JSON or in game commands, and offers control of the sell orders, skins, and names of the shops. Configurations can be applied to multiple shops
Most of the commands use a building hammer or other weapons to tell location or vending machine to run the command on.
Commands:
- /wshop spawn - Will spawn a vending machine at the location of a hammer hit or attack, facing you.
- /wshop apply [name] - Applies a configured shop to a vending machine hit by a hammer hit or attack.
- /wshop disable - Decouples a vending machine from WorldShops and treats it like a normal vending machine. Inventory, sell orders, skins, and names remain.
- /wshop wipe - Decouples and wipes a vending machine to the default state.
- /wshop save [name] - Saves a shop hit by a hammer or attack with the said command name to a shop configuration.
- /wshop delete [name] - Deletes a shop configuration and any shops in the world using it.
- /wshop remote [name] - Remotely accesses a shop. Permissions for this have to be setup on a per shop-configuration basis.
- /wshop list - Lists all the shops' command names and world names as well as instances in the world.
- /wshop help - Shows an in-game message similar to this command list but much more compact.
Permissions
This plugin uses the permission system. To assign a permission, use oxide.grant <user or group> <name or steam id> <permission>. To remove a permission, use oxide.revoke <user or group> <name or steam id> <permission>.- worldshops.remote.[name] - Allows for remotely accessing a shop. Name is the command name of shop that should be remotely accessable.
- worldshops.build - If a user can build in a shop-blocked zone or not.
- worldshops.spawn - If a user can use the "spawn" command.
- worldshops.apply - If a user can use the "apply" command.
- worldshops.disable - If a user can use the "disable" command.
- worldshops.wipe - If a user can use the "wipe" command.
- worldshops.save - If a user can use the "save" command.
- worldshops.delete - If a user can use the "delete" command.
Configuration
The settings and options can be configured in the WorldShops file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.Default settings are included to demonstrate the settings file and nothing more. To do anything with this mod you need to adjust the settings.
Notification Settings:
- Enabled - Whether or not to use the feature
- FadeIn - Speed to fade in in seconds. A minimum of 0.5 is recommended so the client to load the image before it is noticeable to prevent seeing a stretch rust placeholder image.
- WaitTime - Time to wait before fading out.
- FadeOut - Speed to fade out in seconds.
Shop Settings:
- SellOrders - Array of orders to buy/sell items for (pairs of sell and buy item settings).
- WorldName - Name that appears on the map and in the game UI (text).
- CommandName - Name to use when applying the configuration and the like using commands. There can be no duplicates between shop configurations (text).
- SkinId - The ID of the skin you want to apply to the shop (does not have to be approved on the workshop for it to work) (positive non-decimal number).
- BuildingBlockedDistance - Distance needed between you and the vending machine to build. If you are an admin you can build within this distance so long as it's adding onto the building the shop is in (decimal number).
Sell/Buy Item Settings:
- ShortName - The shortname of the item to sell/buy (text).
- Quantity - Amount of it to sell/buy (non-decimal number).
- Blueprint - Is the item to sell/buy a blueprint? (true/false).
Possible additions:
- Safe zones near shops (bordering on zone mods though...)
- Chill scientists near shops
