> For the complete documentation index, see [llms.txt](https://thanhpahts-organization.gitbook.io/product-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://thanhpahts-organization.gitbook.io/product-docs/lagoon-token/lagoontoken-wiki.md).

# LagoonToken Wiki

## I. INTRODUCTION

This plugin supports the creation of unlimited server-side tokens and builds dedicated leaderboard systems for each token based on specific timeframes (weekly, monthly). It features support for MySQL and SQLite, comprehensive placeholder support, and much more.

## II. CONFIG

### 1. MySQL

```
data-storage:
  enabled: false
  mysql:
    host: localhost
    port: 3306
    database: lagoontoken_data
    username: root
    password: ""

```

This plugin supports storing data in **MySQL**. To use it, you need to **create a database** named **"lagoontoken\_data"**.

### 2. Storage and top

```
    storage: SQLITE
    start-balance: 0
    top-enabled: true
    top-snapshot: true
    transaction-log: true

    # Prevent manual and scheduled resets.
    never-reset: true
    
```

storage: SQLITE / MYSQL | choose a storage method

top-enabled: true/false | If set to false, the top system for this token will be bypassed, the placeholder will not return any value, and you will not be able to reset this token.

top-snapshot: true/false | For MySQL; used to store top list data in MySQL. You can use this for a website; set this to `false` if the token is not stored in MySQL.

never-reset: true/false | If set to false, you will not be able to reset this token for any reason, thereby preventing data loss that could result from a reset and ensuring the data remains unrecoverable.

### 3. Placeholder synC

```
placeholder-sync:
  enabled: false
  value: ""
  debug: false
```

This feature allows you to synchronize any placeholder with your token, provided the placeholder returns a numeric value (containing no characters). The plugin supports number abbreviation formats such as 1000, 1k, 1.3m, 2b, and 1t.

```
value: "%playerpoints_points%"
```

If I set the value this way, this token will synchronize directly with PlayerPoints points. The plugin will perform the synchronization whenever a player leaves or joins the server.

It is recommended to use this feature only for displaying and summarizing rankings when certain token plugins—such as PlayerPoints—do not support a built-in ranking function.

### 4. Reset and rewards

```
reset:
  enabled: true
  type: WEEKLY
  day-of-week: SUNDAY
  day-of-month: 1
  time: "20:00"

  broadcast:
    - "&e%token% leaderboard is resetting now."

  global-commands:
    - "say Event Point reset!"

  rewards:
    1:
      commands:
        - "crate key give %player% legendary 5"
    2:
      commands:
        - "crate key give %player% legendary 3"
    3:
      commands:
        - "crate key give %player% legendary 1"
```

This feature allows for the automatic locking of the top position at a preset time.

Type: WEEKLY / MONTHLY 

day-of-week: monday - sunday

day-of-month: 1-30

## III. PLACEHOLDER

%lagoontoken\_\<token>\_amount%\
%lagoontoken\_\<token>\_total%\
%lagoontoken\_\<token>\_display%\
%lagoontoken\_\<token>\_top\_\<rank>\_name%\
%lagoontoken\_\<token>\_top\_\<rank>\_amount%

## IV. COMMAND AND PERMISSION

lagoontoken.use:

* /lagoontoken top \<token> - top list of token
* /lagoontoken history - transaction history of player
* /lagoontoken - see your balance

lagoontoken.admin

* /lagoontoken set \<player> \<token> - set player tokeb
* /lagoontoken take \<player> \<token> - take player token
* /lagoontoken give \<player> \<token> - give token to player
* /lagoontoken reset \<token> - reset token