# Getting Started

## Requirements <a href="#cd7b1a47-4080-436f-a2f9-c932975fa365" id="cd7b1a47-4080-436f-a2f9-c932975fa365"></a>

* Spigot / PaperMC
  * All fork can work but can’t test all of these. Report me any fork don’t work with CreativeManager

## Installation

1. Download JAR file from Spigot
2. Put the jar file in your plugins server directory
3. Restart your server

## Configuration

### Protections

Each protections on CreativeManager can be enabled or disabled with this command.

```
/cm settings
```

Configuration File

You can find the config.yml on the CreativeManager directory

{% hint style="info" %}
**All information about CreativeManager config file be in the** [**⚙️Configuration file**](https://wiki.k0bus.fr/CreativeManager%20Wiki%203360889f7ac44cfa9d81ca6a7fe0d71e/Configuration%20file%20e1b004f256cd4521a76952a9fa055991.html) **.**
{% endhint %}


# Configuration

{% hint style="info" %}
**Tip:** This page refere to the orginal config.yml file.
{% endhint %}

## File location

config.yml is located on the plugins Directory under CreativeManager

## Default file

CreativeManager generate your first config file at startup.

This file contain default configuration.

```yaml
##Plugin configuration
tag: '&r[&cCreativeManager&r] '
lang: en_EN
log: true
save-interval: 300
save-log: true
send-player-messages: true
antispam-tick: 5
## Protection module
protections:
  container: true #Bypass : creativemanager.bypass.container
  spawn: false #Bypass : creativemanager.bypass.spawner
  drop: true #Bypass : creativemanager.bypass.drop
  pickup: true #Bypass : creativemanager.bypass.pickup
  build: false #Bypass : creativemanager.bypass.build
  entity: true #Bypass : creativemanager.bypass.entity
  pvp: false #Bypass : creativemanager.bypass.hit.player
  pve: false #Bypass : creativemanager.bypass.hit.monster
  lore: true # Bypass : creativemanager.bypass.lore
  loot: true
  spawn-build: true
  throw: true
  commands: true
  useblock: true
  blockcopy: true
  gui: false
  custom-nbt: false
  armor: false
  build-container: true #Bypass : creativemanager.bypass.build-container
  plugins:
    citizens: true
    chestshop: true
    slimefun: true
## Multi inventory
inventory:
  adventure: true #Bypass : cm.bypass.inventory
  creative: true #Bypass : cm.bypass.inventory
  spectator: true #Bypass : cm.bypass.inventory
stop-inventory-save: false #Use it at your own risk, this option fully disable the inventory save system.
## List
list:
  mode:
    place: blacklist
    use: blacklist
    get: blacklist
    break: blacklist
    commands: blacklist
    useblock: blacklist
  place: #Bypass : creativemanager.bypass.blacklist.place
    - 'tnt'
  use: #Bypass : creativemanager.bypass.blacklist.use
    - 'lava_bucket'
    - 'flint_and_steel'
    - 'fire_charge'
  get: #Bypass : creativemanager.bypass.blacklist.get
    - 'diamond'
  break:
    - 'bedrock'
  commands:
    -  'somecommandtoblacklist optionnaly with some argument'
  useblock:
    - 'CRAFTING_TABLE'
creative_armor:
  helmet:
    name: '&6Creative Helmet'
    lore:
      - '&7This creative Helmet is bind to your Gamemode !'
    material: BEDROCK
    model-data: 0
    items-adder: ''
  chestplate:
    name: '&6Creative Chestplate'
    lore:
      - '&7This &6Creative Chestplate&7 is bind to your Gamemode !'
    material: LEATHER_CHESTPLATE
    leather-color:
      red: 255
      green: 255
      blue: 255
    model-data: 0
    items-adder: ''
  leggings:
    name: '&6Creative Leggings'
    lore:
      - '&7This &6Creative Leggings&7 is bind to your Gamemode !'
    material: CHAINMAIL_LEGGINGS
    model-data: 0
    items-adder: ''
  boots:
    name: '&6Creative Boots'
    lore:
      - '&7This &6Creative Boots&7 is bind to your Gamemode !'
    material: CHAINMAIL_BOOTS
    model-data: 0
    items-adder: ''
## Lore settings
creative-lore:
  - '&5Creative {ITEM}'
  - '&7Generate by {PLAYER}'
  - '&7{UUID}'
```

## Configuration details

| Node                | Description                                                 |
| ------------------- | ----------------------------------------------------------- |
| tag                 | Allow you to edit the plugins tags                          |
| lang                | Configure with the lang file name                           |
| log                 | Allow CreativeManager to log in console protections actions |
| save-interval       | Delay between each inventory save                           |
| save-log            | Allow CreativeManager to save block log                     |
| send-player-message | Send player message with CreativeManager protections        |
| protections.\*      | Enable / Disable protections                                |
| inventory.\*        | Enable / Disable inventory switch                           |
| blacklist.\*        | Add some items / block on the blacklist                     |
| creative-lore       | Edit the Creative lore added on Creative items.             |

## Blacklist usage

Blacklist can be easily used with '\*'.

The following example blacklist all 'somecommand' command and subcommands and also deny 'anothercommands sub' command and subcommand.

This example also deny placing all type of LOG

```yaml
list:
  place: 
    - '*_LOG'
  commands:
    - 'somecommand*'
    - 'anothercommands sub*'
```

#### Tag usage in blacklist

With 1.31.1 update server owner can use Tag in the blacklist config. These Tag are managed by Spigot and can change with future update.

{% hint style="info" %}
Official Tag list can be found here : <https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Tag.html>
{% endhint %}

For helping everyone server admin can run the \`/cm items\` commands to get some informations like the TAG list of the in hand item.

```yaml
list:
  place:
    - '#PLANKS'
```

The above example disallow placement of every planks block.

#### List mode

With 1.31.1 update server owner can now change the list mode.

{% tabs %}
{% tab title="whitelist" %}
Whitelist allow all items listed for usage and disallow unlisted items.
{% endtab %}

{% tab title="blacklist" %}
Whitelist disallow all items listed for usage and allow unlisted items.
{% endtab %}
{% endtabs %}


# Permissions

## Administration permissions <a href="#id-00645bb0-c565-47e7-9fa6-597e5dd4e239" id="id-00645bb0-c565-47e7-9fa6-597e5dd4e239"></a>

| Node                   | Descriptions                 |
| ---------------------- | ---------------------------- |
| creativemanager.reload | Allow to reload plugins      |
| creativemanager.admin  | Allow using settings command |

## Protections permissions <a href="#id-3fc849ff-ae10-44b1-ab20-42268250c825" id="id-3fc849ff-ae10-44b1-ab20-42268250c825"></a>

| Node                                        | Descriptions                                                     |
| ------------------------------------------- | ---------------------------------------------------------------- |
| creativemanager.bypass.container            | Allow using container in Creative Mode                           |
| creativemanager.bypass.gui                  | Allo using GUI in Creative Mode                                  |
| creativemanager.bypass.ignite               | Allow ignite block in Creative Mode                              |
| creativemanager.bypass.spawner              | Allow using spawn-egg and place spawner in Creative Mode         |
| creativemanager.bypass.drop                 | Allow drop item in Creative Mode                                 |
| creativemanager.bypass.pickup               | Allow pickup item in Creative Mode                               |
| creativemanager.bypass.build                | Allow build/break in Creative Mode                               |
| creativemanager.bypass.entity               | Allow interact with entity in Creative Mode                      |
| creativemanager.bypass.inventory            | Bypass Creative Inventory Mode                                   |
| creativemanager.bypass.lore                 | Bypass Creative Lore                                             |
| creativemanager.bypass.pvp                  | Allow hit player                                                 |
| creativemanager.bypass.pve                  | Allow hit monster                                                |
| creativemanager.bypass.loot                 | Creative placed block can't be looted                            |
| creativemanager.bypass.spawn\_build         | Allow creative player to build golem                             |
| creativemanager.bypass.blockcopy            | Allow creative player to Copy Block with NBT                     |
| creativemanager.bypass.enchants-and-potions | Allow creative player to enchant items or create Customs potions |
| creativemanager.bypass.throw                | Allow player to throw item (Arrow / Potion / ...)                |
| creativemanager.bypass.break-creative       | Allow survival player to break Creative placed block             |
| creativemanager.bypass.log                  | Allow survival player to loot drop after creative block break    |

## Blacklist permissions <a href="#c6eca370-36ac-41f9-acb3-96008b581cfb" id="c6eca370-36ac-41f9-acb3-96008b581cfb"></a>

| Node                                      | Descriptions                       |
| ----------------------------------------- | ---------------------------------- |
| creativemanager.bypass.blacklist.place    | Player bypass 'place' blacklist    |
| creativemanager.bypass.blacklist.use      | Player bypass 'use' blacklist      |
| creativemanager.bypass.blacklist.get      | Player bypass 'get' blacklist      |
| creativemanager.bypass.blacklist.break    | Player bypass 'break' blacklist    |
| creativemanager.bypass.blacklist.commands | Player bypass 'commands' blacklist |
| creativemanager.bypass.blacklist.useblock | Player bypass 'useblock' blacklist |

## Plugins protections <a href="#id-804664c0-607d-44c6-89d6-02ac08bed855" id="id-804664c0-607d-44c6-89d6-02ac08bed855"></a>

| Node                             | Descriptions                                            |
| -------------------------------- | ------------------------------------------------------- |
| creativemanager.bypass.slimefun  | Allow creative player to use Slimefun protected actions |
| creativemanager.bypass.chestshop | Allow creative player to use ChestShop plugin           |


# Contact Us

* [SpigotMC](https://www.spigotmc.org/resources/%E2%9A%A1-creativemanager-%E2%9A%A1-customizable-complete-control.75097/)
* [Discord](https://wiki.k0bus.fr/)


