/// PIMPMYRUST PLUGIN
Vote System
Settings guide for this version of Vote System. Check the plugin page before using it on your server.
Prepare your file
- Check the installed version
This guide describes Vote System 2.1.4. 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 1
- Configuration format version
- Choice · required
Internal configuration format marker. Keep the value supplied for this plugin version.
JSON path
Data VersionAllowed values: 2
CustomRewards 2
- Enable
- On / off · required
Forward vote points to the configured CustomRewards reward type. CustomRewards must be installed; this integration is optional.
JSON path
Plugin Extensions → CustomRewards → Enabled - CustomRewards reward type
- Text · required
Exact reward type name used by the integration, without .json.
JSON path
Plugin Extensions → CustomRewards → Custom Rewards Template Name
Economics 2
- Enable
- On / off · required
Deposit an Economics amount based on vote points and the multiplier. Economics must be installed; disable if you do not use this currency.
JSON path
Plugin Extensions → Economics → Enabled - Economics deposit multiplier
- Whole number · required
Converts accepted voting points into the amount to deposit.
JSON path
Plugin Extensions → Economics → MultiplicatorMinimum : 1 · Maximum : 1000000
RustServers 5
- Enable
- On / off · required
Query RustServers for new votes. Enable only after entering your server’s credentials for that site.
JSON path
Vote Servers Settings → RustServers → Enabled - Voting site API URL
- Text · required
RustServers API address used to check votes. Keep the address intended for this provider, not your public server-listing URL.
JSON path
Vote Servers Settings → RustServers → API Url - API token
- Text · required
Secret supplied by the voting service. It is masked in the form.
JSON path
Vote Servers Settings → RustServers → API Token - Points granted per vote
- Whole number · required
Internal points granted for each new vote accepted from this site. Integrations consume these points; this is not directly an item quantity.
JSON path
Vote Servers Settings → RustServers → Points by voteMinimum : 1 · Maximum : 1000000
- Nickname → Steam ID links
- JSON value · required
Link each nickname to the corresponding player's Steam ID. Do not change a link to move a balance.
JSON path
Vote Servers Settings → RustServers → Nickname to Steam ID bindings
TopGames 5
- Enable
- On / off · required
Query TopGames for new votes. Enable only after entering your server’s credentials for that site.
JSON path
Vote Servers Settings → TopGames → Enabled - Voting site API URL
- Text · required
TopGames API address used to check votes. Keep the address intended for this provider, not your public server-listing URL.
JSON path
Vote Servers Settings → TopGames → API Url - API token
- Text · required
Secret supplied by the voting service. It is masked in the form.
JSON path
Vote Servers Settings → TopGames → API Token - Points granted per vote
- Whole number · required
Internal points granted for each new vote accepted from this site. Integrations consume these points; this is not directly an item quantity.
JSON path
Vote Servers Settings → TopGames → Points by voteMinimum : 1 · Maximum : 1000000
- Nickname → Steam ID links
- JSON value · required
Link each nickname to the corresponding player's Steam ID. Do not change a link to move a balance.
JSON path
Vote Servers Settings → TopGames → Nickname to Steam ID bindings
TopServer 5
- Enable
- On / off · required
Query TopServer for new votes. Enable only after entering your server’s credentials for that site.
JSON path
Vote Servers Settings → TopServer → Enabled - Voting site API URL
- Text · required
TopServer API address used to check votes. Keep the address intended for this provider, not your public server-listing URL.
JSON path
Vote Servers Settings → TopServer → API Url - API token
- Text · required
Secret supplied by the voting service. It is masked in the form.
JSON path
Vote Servers Settings → TopServer → API Token - Points granted per vote
- Whole number · required
Internal points granted for each new vote accepted from this site. Integrations consume these points; this is not directly an item quantity.
JSON path
Vote Servers Settings → TopServer → Points by voteMinimum : 1 · Maximum : 1000000
- Nickname → Steam ID links
- JSON value · required
Link each nickname to the corresponding player's Steam ID. Do not change a link to move a balance.
JSON path
Vote Servers Settings → TopServer → Nickname to Steam ID bindings
RustServers · Vote checks 1
- Check interval (seconds)
- Whole number · required
Seconds between new-vote checks on this site. Shorter intervals increase API requests and may exceed its limits.
JSON path
Vote Servers Settings → RustServers → Routine Settings → Check Interval (seconds)Minimum : 15 · Maximum : 86400
TopGames · Vote checks 1
- Check interval (seconds)
- Whole number · required
Seconds between new-vote checks on this site. Shorter intervals increase API requests and may exceed its limits.
JSON path
Vote Servers Settings → TopGames → Routine Settings → Check Interval (seconds)Minimum : 15 · Maximum : 86400
TopServer · Vote checks 1
- Check interval (seconds)
- Whole number · required
Seconds between new-vote checks on this site. Shorter intervals increase API requests and may exceed its limits.
JSON path
Vote Servers Settings → TopServer → Routine Settings → Check Interval (seconds)Minimum : 15 · Maximum : 86400
Plugin instructions
Vote System 2.1.4 beta
Export the JSON for the 2.1.4 beta. This is not the Codefling Main release.
Install the file
After keeping a copy of the previous file, place the exported JSON at this location on your server:
oxide/config/VoteSystem.jsonFollow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.