> ## Documentation Index
> Fetch the complete documentation index at: https://docs.minestorecms.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Learn more about the Official MineStoreCMS Minecraft Plugin.

# Table of Contents

1. [Configuration](#configuration)
2. [Permissions](#permissions)
3. [Placeholders](#placeholders)

## Configuration

### config.yml

```yaml theme={null}
# MineStore Configuration
# This is the configuration file for MineStore.
# Only enable debug if requested by a MineStore developer.
debug: false
# This is the language that is used by the plugin. This config option is required. Available languages: en_US, cs_CZ, ru_RU, ua_UA but you can create your own language file.
language: en_US
# Store URL is the URL to your MineStore website. This config option is required.
store-url: "https://store.example.com"
weblistener:
  secret-enabled: false
  # This is the secret key that is used to authenticate the webhooks. This config option is required if secret-enabled is set to true.
  secret-key: extraSecretKey
api:
  key-enabled: false
  # This is the secret key that is used to authenticate the API. This config option is required if key-enabled is set to true.
  key: apiSecretKey
# From this point on, all config options are optional.
auth:
  # This is the amount of time in seconds that the player has to authenticate their Minecraft account with MineStore website.
  timeout: 300
store-command:
  # If this config option is set to true, the player will be sent a link to the MineStore website when they run the /minestore store command.
  enabled: false
mysql:
  # If this config option is set to true, the plugin will use MySQL database to store data.
  enabled: true
  # This is the host of the MySQL database. This config option is required if MySQL is enabled.
  ip: localhost
  # This is the port of the MySQL database. This config option is required if MySQL is enabled.
  port: 3306
  # This is the username of the MySQL database. This config option is required if MySQL is enabled.
  username: root
  # This is the password of the MySQL database. This config option is required if MySQL is enabled.
  password: superSecretPassword
  # This is the name of the MySQL database. This config option is required if MySQL is enabled.
  database: minestore
buy-gui:
  # If this config option is set to true, the player will be able to buy packages from the GUI.
  enabled: true
  # All of the following config options are optional and are used to customize the GUI.
  back:
    # Item that is used to go back to the previous menu.
    item: BARRIER
    # Name of the item that is used to go back to the previous menu.
    name: <red>Back
    # Lore of the item that is used to go back to the previous menu.
    description: <red>Go back to the previous menu!
  category:
    # Title of the GUI that is used to display categories.
    title: <bold><blue><obfuscated>Testing Title
    # Name of the item that is used to go to the category menu.
    name: <gold>%category%
  subcategory:
    # Title of the GUI that is used to display subcategories.
    title: <red><bold>%category%
    # Name of the item that is used to open the subcategory menu.
    name: <gold>%subcategory%
  package:
    # Title of the GUI that is used to display packages.
    title: <red><bold>%subcategory%
    # Name of the item that is used to open the package menu.
    name: <gold>%package%
    # Lore of the item that is used to open the package menu.
    description: <white>%description%
    # Format of the price of the package.
    price: '<green>Price: </green><gold>%price%USD</gold>'
```

## Language

### en\_US.yml

```yaml theme={null}
auth:
  # Message that is sent to the player when they try to authenticate their Minecraft account with MineStore website.
  initial-message: <dark_green>You are trying to login in to our store. <click:run_command:/ms
    auth><bold><gold>CLICK HERE</gold></bold></click> to confirm authorization! If
    you are not able to click run /minestore auth.
  # Message that is sent to the player when they successfully authenticate their Minecraft account with MineStore website.
  success-message: <dark_green>You have successfully logged in to our store!</dark_green>
  # Message that is sent to the player when they try to authenticate their Minecraft account with MineStore website but they do not have a pending auth.
  failure-message: <dark_red>You do not have pending auth!</dark_red>
  # Message that is sent to the player when they fail to authenticate their Minecraft account with MineStore website due to timeout.
  timeout-message: <dark_red>You have failed to log in to our store!</dark_red>
store-command:
  # Message that is sent to the player when they run the /minestore store command.
  message: <dark_green>Visit our store <click:open_url:%store_url%><hover:show_text:'<gold>Click
    to open the store!'><bold><gold>here</gold></bold></hover></click>!</dark_green>
buy-gui:
  # Message that is sent to the player when they click on package item.
  message: <dark_green>To buy <red><bold>%package%</bold></red> click <click:open_url:%buy_url%><bold><gold>HERE</gold></bold></click>!
```

## Permissions

* **minestore.auth**
* Allows the player to use the `/minestore auth` command. This command allows the player to authenticate their Minecraft account with MineStore website.
* **minestore.buy**
* Allows the player to use the `/buy` command. This command allows the player to display GUI.
* **minestore.reload**
* Allows the player to use the `/minestore reload` command. This command reloads the config.yml file.
* **minestore.setup**
* Allows the player to use the `/minestore setup` command. This command allows the player to edit the config.yml file in-game.
* **minestore.store**
* Allows the player to use the `/store` command. This command sends the player link to the MineStore website.

## Placeholders

* TopDonators
* **%ms\_top\_donator\_username\_number%**
* Example: %ms\_top\_donator\_username\_1% will return the username with the most amount of money donated.
* Example result: `Notch`
* **%ms\_top\_donator\_price\_number%**
* Example: %ms\_top\_donator\_price\_1% will return the amount of money donated by the user with the most amount of money donated.
* Example result: `1000000`
* LastDonators
* **%ms\_last\_donator\_username\_number%**
* Example: %ms\_last\_donator\_username\_1% will return the username of the last person to donate.
* Example result: `Steve`
* **%ms\_last\_donator\_price\_number%**
* Example: %ms\_last\_donator\_price\_1% will return the amount of money donated by the last person to donate.
* Example result: `100`
* **%ms\_last\_donator\_package\_number%**
* Example: %ms\_last\_donator\_package\_1% will return the name of the package the last person to donate bought.
* Example result: `VIP`
* DonationGoal
* **%ms\_donation\_goal\_current%**
* Example: %ms\_donation\_goal\_current% will return the current amount of money donated.
* Example result: `400`
* **%ms\_donation\_goal\_target%**
* Example: %ms\_donation\_goal\_target% will return the target amount of money to be donated.
* Example result: `1000`
* **%ms\_donation\_goal\_percentage%**
* Example: %ms\_donation\_goal\_percentage% will return the percentage of the donation goal that has been reached.
* Example result: `40`
* **%ms\_donation\_goal\_bar\_number%**
* Example: %ms\_donation\_goal\_bar\_10% will return a bar that represents the percentage of the donation goal that has been reached.
* Example result if percentage is 50%: ![image](https://user-images.githubusercontent.com/62996347/225689985-d6ee5fbc-a80b-484b-908e-046c2869f784.png)