# IL2 stats / Awards system

### Types of awards

The system has three types of awards:

1. rewards for achieving some results during one tour
2. rewards for achieving some results during one mission
3. rewards for achieving some results during one sortie

### Adding and editing awards

The award is added and changed in three steps.

#### Step 1 - the conditions for award

Each award requires the function that specifies the conditions of receiving the award. These functions must be in src/custom/rewards.py file. Examples of functions are in the file.

#### Step 2 - Information about the award in the database statistics

If in the database does not entry about specific award, award function will not be used. To add or change the awards need to go to the admin panel statistics. Now there is a new section - "awards".
Editing form contains more fields:

- Function name - is the name of your function in rewards.py file. If a function with the specified name is not be found - the statistics script will stop working.
- Title - The name of the award in several languages.
- Type - is the type of award. What are the types exists described above.
- Description - description of awards, or conditions.
- Image - the image itself award. The size should be 180x180 pixels.

#### Step 3 - Restart statistics

Once it was created or altered function of award, as well changes to the database - you need to restart the script of statistics.