/// PIMPMYRUST PLUGIN
Vote Reward
Settings guide for this version of Vote Reward. Check the plugin page before using it on your server.
Prepare your file
- Check the installed version
This guide describes Vote Reward 2.2.0. Use the same version in the configurator.
- Import your configuration
Open the configurator and import your current JSON. For a new installation, you can start from the provided example.
- Edit and download
Adjust the settings, fix reported errors, and download the JSON. Keep a copy of your old file before replacing it.
Your configuration is not saved on the site. Keep the exported file; you can import it again later.
Settings for this version
General 3
- CustomRewards reward type
- Text · required
Name of the CustomRewards reward type used to grant vote rewards.
JSON path
CustomRewards reward type - Commands that open the interface
- List · required
Chat commands players can use to open the voting interface.
JSON path
Commands for show UI - Custom CUI document
- JSON value · required
Overrides the CustomRewards document for VoteReward opens. An invalid value blocks opening.
JSON path
CuiDocument
Plugin instructions
Configure Vote Reward 2.2.0
This bundle targets the Vote Reward 2.2.0 candidate from the Flutes repository. It does not claim to match the older version currently published on Codefling. Select the Custom Rewards reward type and the commands that open the voting interface.
The default VoteReward command is /votes; VoteCommands uses /vote by default. If both plugins are installed, keep their configured aliases distinct. Existing VoteReward.json files are not rewritten, so remove vote explicitly from an older file before reloading VoteReward if you want VoteCommands to own /vote.
Visual properties stored at the configuration root are grouped by the Hub and edited in PimpMyCUI Editor. CuiDocument is an optional runtime document for this VoteReward facade. When non-null, it overrides the selected CustomRewards reward-type document for VoteReward opens only. An incompatible document blocks opening; it does not fall back to the reward type's document. Omit it or set null to use the reward type's own document or built-in profile.
The editor may change visuals, add decorative elements or close-only buttons, and remove elements. Existing action elements must retain their IDs, kind and bindings; model paths must come from the built-in CustomRewards document. Theme, presentation, decoration, layout, CUI parent and context image remain part of the same configuration, while CustomRewards reward type, commands and unknown keys are preserved.
The free export produces VoteReward.json for manual installation under oxide/config/. The Hub does not save this draft on the server: download the file to keep it and import it again when you want to resume editing.
Upgrade from contract 1.0.0: existing VoteReward.json files are not rewritten. Add the required CUI profile fields from the current example and keep UI parent exactly Overlay; an invalid existing file is rejected rather than reset to defaults. If VoteCommands owns /vote, remove that alias from the existing Commands for show UI list. CuiDocument is optional and requires matching document-override support in CustomRewards and PimpMyCUI.
Install the file
After keeping a copy of the previous file, place the exported JSON at this location on your server:
oxide/config/VoteReward.jsonFollow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.