/// 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.
- Get the settings
Click Import, then From my server. Select the files and confirm loading them. Selecting a server does not replace the open document. You can also import files from this device or a configuration from My projects.
- Edit and send
Adjust settings, fix errors, then use Send to transfer files to the selected server. A conflict blocks sending until you choose how to resolve it. You can still export only the files you need.
Server transfers have private backups. Save keeps your work in My projects; it does not send anything to the server. A download also lets you resume without a server connection.
Settings for this version
General 5
- CustomRewards reward type
- Text · required
Exact enabled CustomRewards catalogue name, without .json. It must also match the type configured in VoteSystem; a mismatch blocks reward opening.
JSON path
CustomRewards reward type - Commands that open the interface
- List · required
Chat aliases opening vote rewards, without a leading /. Grant players customrewards.<lowercase type>.use; administrators are exempt. Avoid CustomRewards or VoteCommands aliases. Configure voting sites in VoteSystem.
JSON path
Commands for show UI - Custom CUI document
- JSON value
Overrides the CustomRewards document for VoteReward opens. An invalid value blocks opening.
JSON path
CuiDocument - Progression
- Choice
Votes uses votes recorded by VoteSystem. Points preserves legacy CustomRewards point-based progression.
JSON path
Progression mode (legacy-points | votes)Allowed values: legacy-points, votes
- Vote site commands
- List
Chat commands showing the player links to sites configured in VoteSystem. Enter names without a leading slash.
JSON path
Vote site commands
Plugin instructions
Configure VoteReward 2.2.0
Beta 2.2.0. The LTS version published on Codefling remains 2.1.4. Downloading the plugin requires sign-in and a verified entitlement for the requested version. Check its product page for available access. Configuration exports remain available without buying the plugin.
VoteReward opens a CustomRewards catalogue and connects it to VoteSystem. VoteSystem collects votes; CustomRewards delivers rewards. The three plugins must be compatible and use the same catalogue name.
Prepare the pack
- Select the catalogue, usually
VoteSystem, and its opening commands, such as/votes. - Configure vote sites in VoteSystem: enable the sites you use and supply their credentials.
- Add rewards and milestones in the associated CustomRewards catalogue.
- Review selected files and languages before sending or exporting them.
The configurator groups oxide/config/VoteReward.json, oxide/config/VoteSystem.json and oxide/data/CustomRewards_rewards/<catalogue>.json, plus their language files. Use equivalent Carbon directories when applicable. Connected-server transfers retain these file owners and destinations.
Select progression
Votes uses recorded votes and the progression unit from the new VoteSystem pack. It requires that pack's new vote-tracking functions. An older plugin with a higher version number does not provide those functions automatically.
Points preserves legacy CustomRewards point-based progression. Keep it for an earlier installation until the compatible pack is updated. Before changing units on a live catalogue, review milestones and recorded progress.
Vote-site commands display public voting links to players. Provider API tokens belong in server configuration and must never be used as public links.
Appearance and languages
The CustomRewards catalogue selects its renderer: Native without PimpMyCUI, or PimpMyCUI. With PimpMyCUI, Native match uses the PimpMyCUI 1.4.0 runtime compatible with this pack; Family uses the existing templates. The preview uses the associated rewards. Catalogue titles, bridge messages and general messages retain their respective language files.
Version 2.1.4 remains available for its earlier pack. The former 2.2.0 beta is withdrawn; the new normal contract keeps separate drafts.
Install the 2.2.0 pack pages
Page mode uses PimpMyCUI 1.4.0. Install the ZIP files, including oxide/data/PimpMyCUI/plugin-pages/customrewards/manifest.json and its referenced packages, then reload the plugins. The catalogue name is the page’s exact context: keep it consistent in CustomRewards, VoteSystem and VoteReward. An unavailable linked destination must not silently open a different catalogue. Catalogue opening commands retain permission checks and server progression. Export selections must retain their required CUI publications.
Dependencies in both modes
VoteSystem and CustomRewards are required even in legacy Points mode. VoteReward checks their contracts before opening the catalogue; a missing or incompatible plugin makes the interface unavailable. Votes mode additionally requires the tracking capabilities of VoteSystem 2.1.6 and the CustomRewards 2.2.0 pack. Installing VoteReward alone is insufficient.
Install the files
With a connected server, click Send in the configurator. The result shows whether the files were sent and the plugin reloaded. Without RCON, reload the plugin from your server panel after sending.
Without a connected server: Keep a copy of the current files. Place each export in the folder shown before export, or follow the paths in the ZIP. Do not put data or translation files in the config folder.
Follow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.