LushRewards

https://docs.lushplugins.org/lush-rewards/
Admin
LushRewards is a highly configurable rewards plugin that helps server owners reward players for...
Tokens:3,704
Snippets:60
Trust Score:5.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Custom GUI Template Example

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of a custom GUI template format. This demonstrates how to define rows and place elements like borders ('#'), rewards ('R'), and the next reward indicator ('N').

```yaml
template: CUSTOM
format:
  - "#########"
  - "RRRRRRR P"
  - "#########"
```

--------------------------------

### Example Item Reward Configuration

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

A complete example of an item reward, including the type, material, amount, and broadcast messages with player placeholders.

```yaml
type: item
material: diamond
amount: 2
broadcast:
- "%player% just won"
- "2 Diamonds from rewards!"
```

--------------------------------

### Compact GUI Template

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of the 'COMPACT' GUI template format. This is a predefined template and does not require custom format entries.

```yaml
format:
- "RRRRRRR N"
```

--------------------------------

### Default GUI Template

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of the 'DEFAULT' GUI template format. This is a predefined template and does not require custom format entries.

```yaml
format:
- "RRRRRRRRR"
- "RRRRRRRRR"
- "RRRRRRRRR"
- "RRRR#####"
- "#########"
- "####P####"
```

--------------------------------

### Compact Profile GUI Template

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of the 'COMPACT_PROFILE' GUI template format. This is a predefined template and does not require custom format entries.

```yaml
format:
- "RRRRRRR P"
```

--------------------------------

### Bordered GUI Template

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of the 'BORDERED' GUI template format. This is a predefined template and does not require custom format entries.

```yaml
format:
- "#########"
- "RRRRRRR#N"
- "#########"
```

--------------------------------

### DailyRewards+ GUI Template

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of the 'DAILY_REWARDS_PLUS' GUI template format. This is a predefined template and does not require custom format entries.

```yaml
format:
  - "RRRRRRRRR"
  - "RRRRRRRRR"
  - "#RRRRRRR#"
  - "##RRRRR##"
  - "#########"
  - "####P####"
```

--------------------------------

### Reward List Example

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Defines a list of multiple rewards that can be given. Each reward in the list can be of a different type.

```yaml
rewards:
  # This is your first reward
  - type: item
    material: diamond
    amount: 2
  # This is your second reward
  - type: command
    commands:
    - "say Example Reward"
```

--------------------------------

### NDaily Rewards GUI Template

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of the 'NDAILY_REWARDS' GUI template format. This is a predefined template and does not require custom format entries.

```yaml
format:
  - "#########"
  - "#RRRRRRR#"
  - "#########"
```

--------------------------------

### Ask a Question via HTTP GET Request

Source: https://docs.lushplugins.org/lush-rewards/llms.txt

Use this method to query the documentation index with a specific question and an optional end goal. The response includes a direct answer and relevant excerpts.

```http
GET https://docs.lushplugins.org/lush-rewards/lushrewards.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Bordered Large GUI Template

Source: https://docs.lushplugins.org/lush-rewards/configuring/gui-templates.md

Example of the 'BORDERED_LARGE' GUI template format. This is a predefined template and does not require custom format entries.

```yaml
format:
  - "#########"
  - "#RRRRRRR#"
  - "#RRRRRRR#"
  - "#RRRRRRR#"
  - "#RRRRRRR#"
  - "####P####"
```

--------------------------------

### Daily Playtime Reward Format Example

Source: https://docs.lushplugins.org/lush-rewards/configuring/modules/daily-playtime-rewards.md

Defines the structure for a daily playtime reward, including the category, required playtime in minutes, the display item in the GUI, and the list of rewards.

```yaml
  - category: small
    play-minutes: 60
    display-item:
      material: ...
    rewards:
      - ...
```

--------------------------------

### Java/Bedrock Specific Commands

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Execute commands specifically for Java or Bedrock players by prefixing the command with 'java:' or 'bedrock:'.

```yaml
type: command
commands:
- "bedrock:tell %player% bedrock test command"
- "java:tell %player% java test command"
```

--------------------------------

### Define a Daily Reward

Source: https://docs.lushplugins.org/lush-rewards/configuring/modules/daily-rewards.md

Configure a specific daily reward with conditions like day number or date, priority, repetition, display item, and the list of rewards. Use 'on-day' or 'on-date' to specify when the reward is active. 'priority' determines which reward is shown if multiple are active on the same day. 'repeat' sets how often the reward can be claimed.

```yaml
rewardName:
  # The day number that this reward will appear on
  on-day: 1
  # AND/OR
  # The date that this reward will appear on
  on-date: 01-10-1982
  
  # The priority of this reward collection 
  # (if multiple collections appear on the same day the one with the highest
  # priority will be displayed)
  priority: 1
  # How often to repeat the reward (in days)
  repeat: 1
  
  # The category to inherit from
  category: small
  # The display item will be combined with the relevant category template and
  # the default-reward template allowing for easy customization
  display-item:
    lore:
    - "line1"
    - "line2"
  redeem-sound: ENTITY_EXPERIENCE_ORB_PICKUP
  # List of rewards as shown in <a data-footnote-ref href="#user-content-fn-1">Reward Types</a>
  rewards:
  - ...
    
```

--------------------------------

### Item Reward Configuration

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Configures an item reward, specifying the material, amount, display name, lore, enchantment status, custom model data, and skull texture.

```yaml
type: item
material: stone
# Optional Settings:
amount: 2
display-name: "&7Stone"
lore:
- "Lore Line 1"
- "Lore Line 2"
enchanted: true
custom-model-data: 1
skull-texture: mirror # mirror - Shows player's head
```

--------------------------------

### Console Command Execution

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Defines commands that will be executed by the server console.

```yaml
type: command
commands:
- "tell %player% test command"
```

--------------------------------

### Template Reward Usage

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Uses a pre-defined reward template from the `reward-templates.yml` file by specifying its name.

```yaml
type: template
template: reward-name
```

--------------------------------

### Player Command Execution

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Specifies commands that will be executed as if the player themselves ran them.

```yaml
type: player-command
commands:
- "followers set FollowerName"
```

--------------------------------

### Global Playtime Reward Format

Source: https://docs.lushplugins.org/lush-rewards/configuring/modules/global-playtime-rewards.md

Defines the structure for a single playtime reward, including category, claim time, display item, and the rewards themselves. Ensure 'play-minutes' is set to the desired interval in minutes.

```yaml
  - category: small
    # The time in minutes when they can claim this reward
    play-minutes: 60
    # The item to be displayed in the gui
    display-item:
      material: ...
    # List of rewards as shown in Reward Types
    rewards:
      - ...
```

--------------------------------

### YAML Item Template Format

Source: https://docs.lushplugins.org/lush-rewards/configuring/item-templates-and-categories.md

Defines the structure for item templates and categories, specifying properties like material, amount, display name, lore, enchantment status, custom model data, and skull texture. This format is used for both item templates and categories.

```yaml
formatName:
  material: stone
  amount: 2
  display-name: "&7Stone"
  lore:
  - "Lore Line 1"
  - "Lore Line 2"
  enchanted: true
  custom-model-data: 1
  skull-texture: mirror # mirror - Shows player's head
```

--------------------------------

### Define Reward Type

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Every reward must have a type defined. This determines the kind of reward given to the player.

```yaml
type: item
```

--------------------------------

### Random Weighted Rewards

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Selects one reward randomly from a list based on assigned weights. Higher weights increase the probability of selection.

```yaml
type: random
rewards:
- weight: 100
  # Example Reward
  type: command
  commands:
  - "say Example Reward"
```

--------------------------------

### Permission-Based Rewards

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Grants rewards to a player only if they possess the specified permission. Nested rewards can be of any type.

```yaml
type: permission
permission: a.custom.permission
rewards:
- # Example Reward
  type: command
  commands:
  - "say Example Reward"
```

--------------------------------

### Add Messages to Rewards

Source: https://docs.lushplugins.org/lush-rewards/configuring/reward-configuration.md

Optionally include a message for the player receiving the reward and a broadcast message for all online players. Messages can be single or multiple lines.

```yaml
message: "A single line message to the player receiving the reward"
broadcast: "A message to all online players"
```

```yaml
broadcast:
- "This is a"
- "multiple line message"
```
Tokens:
Raw