About Custom Rewards

Give players rewards they can unlock

Choose the rewards and how many points each one takes to unlock. Players earn points, for example by playing, then claim unlocked rewards in Rust. They keep their points after claiming a reward.
Oxide and Carbon · Multiple reward catalogues on one server
Open the PimpMyRust configurator →
How it works in Rust

The configurator’s Survival example awards 1 point for every 15 minutes of active play.
- At 1 point, the player unlocks 100 wood.
-
At 2 points, after 30 minutes, the player also unlocks 50 cloth. They type
/starterto open the menu and claim the rewards. - After claiming both, they still have 2 points. They need one more to unlock 750 stones at the next milestone.

The Survival catalogue at 2 points
How players earn points

Custom Rewards has three automatic ways to award points. Choose one per catalogue.
- Active playtime. Players earn the number of points you set for each interval of active play.
- Daily bonus. Players earn points once a day after reaching the amount of active playtime you set.
- Welcome bonus. Players earn points once, on their first connection with access to the catalogue.
Manual awards. An admin can give points in Rust chat with /customrewards_give <catalogue> <player or SteamID> <points>. This command uses the customrewards.admin permission.
Integrate other plugins. Use External mode to let another plugin handle automatic progression. A compatible or custom-built plugin can use the Custom Rewards API to award a player points in a catalogue of your choice. For example, an event plugin can award points after a challenge.
Reward votes with Vote Reward

The Vote Reward bundle includes Vote System and Custom Rewards. Vote System collects votes, Vote Reward opens the menu with /votes, and Custom Rewards delivers the rewards. The included catalogue unlocks rewards based on how many times the player votes.
Create a catalogue in PimpMyRust

- Start with an example or create a catalogue. Choose how players progress and which command opens the menu.
- Add rewards and set their milestones. A reward can give out Rust items, grant access to a group, or run a command.
- Download the catalogue or send it to a connected server. You can also edit its JSON file directly.

Five included menu layouts

Pick a layout in the PimpMyRust configurator. Change titles, colors and illustrations to suit your server.

Manual installation

-
Extract the ZIP and merge its folders into
oxide/orcarbon/. -
Load the included PimpMyCUI 1.4.0, then CustomRewards. Keep the manifest and five layouts together in
data/PimpMyCUI/plugin-pages/customrewards/. On first load, CustomRewards createsdata/CustomRewards_rewards/main.json. Review the sample reward, setEnabledtotrueand reload. -
Grant
customrewards.main.useand test/rewards_main.
PimpMyCUI and the included layout files are required for the reward menu. The installation guide covers migration from the separate Playtime Reward extension.
You can edit the JSON directly or use the optional PimpMyRust configurator.
