/// PIMPMYRUST PLUGIN
Custom Rewards
Settings guide for this version of Custom Rewards. Check the plugin page before using it on your server.
Prepare your file
- Check the installed version
This guide describes Custom Rewards 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 4
- Configuration format version
- Choice · required
Internal configuration format marker. Keep the value supplied for this plugin version.
JSON path
Data VersionAllowed values: 4
- Enable
- On / off · required
Enable this reward type. Each file defines an independent type; this does not enable every reward type on the server.
JSON path
Enabled - Commands to open rewards
- List · required
Chat commands without the leading / character.
JSON path
Commands for show UI - Interactive experiences
- Object list
Named interactive animations that rewards can reference by ID. They present the result, but do not choose or independently grant the reward.
JSON path
Interactive experiences
Reward settings 1
- Reward list
- Object list · required
Rewards in this type’s milestone order. Configure each item or action and its access rules; moving an entry changes its milestone index.
JSON path
Rewards Settings → Rewards List
Plugin instructions
CustomRewards configuration contract 4.1.0
Each file configures one reward type under oxide/data/CustomRewards_rewards/<reward-type>.json. Keep Data Version at 4. The reward catalogue, conditions, commands and interactive experiences remain in that same file.
UI Settings selects a theme, presentation, decoration and layout. The layout determines the maximum rewards per page: command-center 3, field-journal 5, signal-deck 8. Set Max Reward By Page accordingly. CuiDocument is an optional PimpMyCUI runtime document produced by the site editor for the selected profile. Omit it or set it to null for the built-in document. A non-null document is checked against the selected built-in screen and event declarations; incompatible documents prevent the UI from opening. No alternate UI is substituted.
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 document. Export the complete reward-type JSON after editing. Installing only a PimpMyCUI project/package does not update this consumer's selected UI.
Each entry of Interactive experiences can independently set CuiDocument for its selected Rich template id (the six chest, wheel and scan templates). The main UI Settings.CuiDocument does not change interactive scenes. The same visual-only contract and fail-closed behavior apply to each experience.
Migration from contract 4.0.0: existing files keep their behavior. The new UI Settings.CuiDocument field is optional and requires document-override support in both the server plugin and PimpMyCUI runtime.
Install the file
After keeping a copy of the previous file, place the exported JSON at this location on your server:
oxide/data/CustomRewards_rewards/reward-type.jsonFollow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.