Configuration
Understanding the files:
Reward templates (UI + reward list) are located in the
Oxide/Data/CustomRewards_rewardsfolder.When you create a template, the file name will serve as its identifier (also called
rewardsTypeortemplate).All player-related data (earned points) will be stored in a folder named after your template (for example, for a template named 'MyRewards', the folder will be
Oxide/Data/CustomRewards_MyRewards_players).
Fields available in template files (rewardsType):
Enabled: Activate or deactivate this template.
Commands for show UI: List of commands to open this template's UI.
UI Settings: UI configuration details:
Max Reward By Page: Maximum number of rewards displayed per page.
Window Rect: Position and size of the window.
Top Rect: Position and size of the title bar.
Close Rect: Position and size of the close button.
Description Rect: Position and size of the description root.
Rewards Rect: Position and size of the rewards root.
Line Rect: Position and size of the progress line.
Reward Margin: Margin between each reward.
Show Description: Option to display or hide the description.
Description font size: Font size of the description.
Title font size: Font size of the title.
Background Url: URL of the background image for a reward.
New Icon Url: URL of the icon when the reward is new.
Check Icon Url: URL of the icon when a reward has been claimed.
Lock Icon Url: URL of the icon when a reward is locked.
Prev Icon url: URL of the previous arrow.
Next Icon url: URL of the next arrow.
Theme: Color palette with available colors such as Surface, SurfaceDisabled, Background, TextPrimary, TextOnSecondary, Primary, Secondary, and Danger.
Rewards: List of rewards with their properties:
Rarity: Reward rarity (Common, Rare, Epic, Legendary).
Quantity: Displayed quantity; for an item, the player will receive this quantity.
Item Name: Item to be received (optional).
Server Commands: List of commands to execute when the player claims the reward.
Grant Permissions: List of permissions to grant (or remove) to the player when they claim the reward.
Grant Groups: List of groups to grant (or remove) to the player when they claim the reward.
Need Permissions: List of permissions required to unlock the reward.
Need Groups: List of groups required to unlock the reward.
Addon Configuration:
Most addons will offer a "Rewards Type" or "Template Name" field. Specify the template name to use in this field.
You can use the same template name for multiple addons, allowing players to earn points in different ways for the same template. Alternatively, you can separate templates to have a distinct template for each type of acquisition.
Last updated