Website/docs/customization/config.md

151 lines
4.7 KiB
Markdown
Raw Normal View History

2022-02-01 05:49:02 +00:00
---
id: config
title: Configuration
---
# Introduction
This page will show you how to modify the configuration file. The configuration file is located at: ```/plugins/Plex/config.yml```.
2022-02-04 22:26:27 +00:00
## Default configuration
2022-02-02 02:15:26 +00:00
Below is the default `config.yml` file when Plex is loaded for the first time.
```yaml title=/plugins/Plex/config.yml
# Plex Configuration File
2022-02-04 08:23:29 +00:00
# For documentation, please visit: https://docs.plex.us.org
2022-02-02 02:15:26 +00:00
server:
name: "Plexus"
motd: "%servername% - Minecraft %mcversion%"
colorize_motd: true
# Ban message is customized here. Additional messages can be configured in messages.yml
banning:
message: "&cYou are banned! Please appeal on the forums at https://forum.plex.us.org/"
# Settings for commands relating to Plex
commands:
# Should Plex use a "true op" system with ranks or only permission nodes
permissions: ranks
data:
central:
storage: sqlite # Use mariadb, mongodb, or sqlite here
user: ""
password: ""
hostname: 127.0.0.1
port: 27017
db: "plex"
side: # This is Redis, leave password blank if auth is false
2022-02-04 08:23:29 +00:00
enabled: false
2022-02-02 02:15:26 +00:00
auth: true
hostname: 127.0.0.1
port: 6379
password: ""
worlds:
flatlands:
name: "Flatlands"
parameters:
grass_block: 1
dirt: 32
stone: 16
bedrock: 1
adminworld:
name: "Admin World"
parameters:
grass_block: 1
dirt: 32
stone: 16
bedrock: 1
masterbuilderworld:
name: "MasterBuilder World"
parameters:
grass_block: 1
dirt: 32
stone: 16
bedrock: 1
# Additional logging for debugging
debug: false
```
2022-02-04 22:26:27 +00:00
## Server
2022-02-02 02:15:26 +00:00
### server.name
The name of your server goes here and is used throughout Plex.
### server.motd
The text here will appear on the server list.
### server.colorize_motd
This determines if the message of the day should randomly be colorized. You can disable this option and manually colorize your MOTD.
2022-02-04 22:26:27 +00:00
## Banning
2022-02-02 02:15:26 +00:00
### banning.message
This message will appear whenever a player tries to join the server, but is banned. You can use any color coding you would like here.
2022-02-04 22:26:27 +00:00
## Commands
2022-02-02 02:15:26 +00:00
### comamnds.permissions
**Options:** `ranks` or `permissions`
This determines how Plex's command system works. If `ranks` is selected, Plex will use a ranking system and give all players operator status. If `permissions` is selected, no players are given operator. Instead, every command will have a permission attached to it which can be assigned in any permission system.
2022-02-04 22:26:27 +00:00
## Data
2022-02-02 02:15:26 +00:00
### data.central.storage
**Options**: `sqlite`, `mariadb`, `mongodb`
Select which database software you would like to use. `sqlite` is the default. Note that if you change which data storage you use, no data will be transferred.
### data.central.user
This is the username for whichever database software you use. Note that `sqlite` does not require a username.
### data.central.password
This is the password for whichever database software you use. Note that `sqlite` does not require a password.
### data.central.hostname
This is the hostname for whichever database software you use. Note that `sqlite` does not require a hostname.
### data.central.port
This is the port for whichever database software you use. Note that `sqlite` does not require a port.
### data.central.db
This is the name for whichever database software you use. Note that `sqlite` does not require a name.
2022-02-04 08:23:29 +00:00
### data.side.enabled
**Options**: `true` / `false`
This will enabled Plex's Redis functionality.
2022-02-02 02:15:26 +00:00
### data.side.auth
**Options**: `true` / `false`
This is whether authentication mode for Redis is turned on or not
:::info
It is highly recommended to have Redis authentication turned on.
:::
### data.side.hostnane
This is the hostname for Redis. This is required for Redis to work.
### data.side.port
This is the port that Redis is listening on. This is requird for Redis to work.
### data.side.password
This is the password for your Redis instance. Note that this can be left if authentication is turned off.
2022-02-04 22:26:27 +00:00
## Worlds
2022-02-02 02:15:26 +00:00
An infinite amount of worlds can be generated from the configuration file. A few are automatically generated by default. The format for generating new worlds is as follows:
```yaml title=/plugins/Plex/config.yml
<world_name>:
name: 'Human readable name'
parameters:
grass_block: 1
dirt: 32
stone: 16
bedrock: 1
```
Note that in the `parameters` section, this is how the world should actually be generated. The order is from top to bottom. In the example above, a world will generate with one grass layer, 32 layers of dirt, 16 layers of stone, and one layer of bedrock.
2022-02-04 22:26:27 +00:00
## Debugging
2022-02-02 02:15:26 +00:00
**Options:** `true` / `false`
The `debug` option is standalone and enables additional logging. This may be useful for diagnosing issues as more information will be displayed in the console. It is recommended to keep this option turned off.