Upstream/CoreProtect
1
0
Fork 0
mirror of https://github.com/PlayPro/CoreProtect.git synced 2024-10-30 08:19:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added configuration page to documentation

Browse Source
This commit is contained in:
Intelli 2021-06-03 17:54:11 -06:00
parent 2c18e0e6b7
commit 3f075e8cf7
2 changed files with 49 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/config.md Normal file
View File

@ -0,0 +1,31 @@
# Configuration
The CoreProtect configuration file can be found within the CoreProtect folder, at `config.yml`.
## Per-World Configuration
If you'd like to modify the logging settings for a specific world, simply do the following:
1. Copy the config.yml file to the name of the world (e.g. world_nether.yml)
2. In the new file, modify the logging settings as desired.
3. Either restart your server, or type "/co reload" in-game.
Secondary configuration files override the value specified in config.yml. If you leave an option out of a secondary configuration file, then the option specified in config.yml will be used.
#### Examples
* If you'd like to disable all logging for the End, copy the `config.yml` file to `world_the_end.yml` (matching the folder name for the world). Then, simply disable all logging options within the new file.
* If you just want to disable entity death logging in the Nether, but keep all other logging options the same, simply create a file named `world_nether.yml` containing the text "rollback-entities: false".
## Disabling Logging
To disable logging for specific users or commands, simply do the following:
1. In the CoreProtect plugin directory, create a file named `blacklist.txt`.
2. Enter the names of the users (or commands) you'd like to disable logging for (each username on a new line).
3. Either restart your server, or type "/co reload" in-game.
This can be used to disable logging for non-player users, such as "#tnt". For example, if you'd like to disable logging for the user "Notch" and for TNT explosions, the blacklist.txt file would look like this:
```text
Notch
#tnt
```

19
docs/index.md
View File

@ -4,4 +4,21 @@ For more information about CoreProtect, visit [coreprotect.net](http://coreprote
## Getting Started ## Getting Started
This project is still under development, and is not yet ready for testing or contributions. These documents are still a work in progress.
Please be sure to visit the following links for more information.
**CoreProtect Commands**
A list of all commands that can be used within CoreProtect.
[https://minerealm.com/community/viewtopic.php?f=32&t=6781](https://minerealm.com/community/viewtopic.php?f=32&t=6781)
**CoreProtect Permissions**
A list of all permissions that can be used with CoreProtect.
[https://minerealm.com/community/viewtopic.php?f=32&t=6782](https://minerealm.com/community/viewtopic.php?f=32&t=6782)
**CoreProtect API Documentation**
Log your own block changes, perform lookups, rollbacks, restores, and more.
[https://minerealm.com/community/viewtopic.php?f=32&t=16687](https://minerealm.com/community/viewtopic.php?f=32&t=16687)
**Compatible Third-Party Plugins & Tools**
A list of plugins and tools that are compatible with CoreProtect.
[https://dev.bukkit.org/projects/coreprotect/pages/compatible-third-party-plugins-tools](https://dev.bukkit.org/projects/coreprotect/pages/compatible-third-party-plugins-tools)