> For the complete documentation index, see [llms.txt](https://flipcard.superiormc.cn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://flipcard.superiormc.cn/flip-ui/ui-config/rewards-option.md).

# Rewards Option

## Item Format

Each reward must has item to display. Should use Item Format at [this](https://ultimateshop.superiormc.cn/base/item-format) page.

**Example:**

```yaml
  1:
    material: DIAMOND
    custom-model-data: 0
    name: '&eA Reward'
    lore:
      - '&fLine1'
      - '&fLine2'
    # For command rewards, you should set this option to false.
    # Otherwise, players will get both item you set here and also the commands reward.
    give-item: true
    # Random amount.
    amount: 1~10
    chance: 20
    edge: rare
```

## General Options

Those options can be used in the 2 types of reward. **All of them except rate are optional.**

* amount: The amount of reward items. Like `1`. You can also entry in the form of "`1~5`" which means the amount is random in the interval. 
* times: How many times the commands excute, can be used as random money amount. You can also entry in the form of "`1~5`" which means the times is random in the interval. 
* give-item: Whether give the item to the player. Recommend set false if just want to use commands as reward. Like: `true`.
* actions: The action will active after finish flip (close flip UI). Use **Action Format** here, for more info, please view [Format](/info/format.md) page. 
* flip-actions: The action will active when flip the card. **For safely reason, only recommand use announcement action here.** Use **Action Format** here, for more info, please view [Format](/info/format.md) page. 
* rate: The weight of the reward. Real rate is this `reward rate/all rewards total rate`.

You can also use `rates` option to replace `rate` option to make dynamic rate, like:

```yaml
rates:
  default: 0.1
  one_rates_condition: 0.4
```

This means default players will have 0.1 rate for this reward, players meet `one_rates_condition` condition (view rates-conditions option below) have 0.4 rate.

This rate supports PlaceholderAPI's placeholder and Math string, like this: **(You need enable math.enabled option in config.yml file to use Math string)**

<figure><img src="/files/5CaPbAmbbOhTLNts3RL2" alt=""><figcaption></figcaption></figure>

* rates-conditions:&#x20;

```yaml
rates-conditions:
  one_rates_condition:
    1:
      type: world
      world: 'OneWorld'
```

`one_rates_condition` is Condition ID, can write it at rates option like this format. In this example, players who in OneWorld will have 0.4 rate.

Each condition id section should use **Condition Format**, for more info, please view [Format](/info/format.md) page.

* edge: The textures of reward edge. It can express rarity. If not set, card won't have any edge.
* limit: The max limit of the reward in a card flip event. Set 1 means you can only get this reward once in a card flip event.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://flipcard.superiormc.cn/flip-ui/ui-config/rewards-option.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.