Skip to content

Commit

Permalink
Merge pull request #10 from skuzow/develop
Browse files Browse the repository at this point in the history
docs: complete readme
  • Loading branch information
skuzow authored Jul 2, 2022
2 parents b03dee9 + b0ab0aa commit 63750eb
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,32 @@
Simple [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) offline whitelist helper plugin.

More plugins in [MCDReforgedPluginsCatalogue](https://github.com/MCDReforged/PluginCatalogue/blob/catalogue/readme.md).

## 🗿 Commands

- `!!offw` Display help message
- `!!offw add <username>` Add player to whitelist
- `!!offw remove <username>` Remove player from whitelist
- `!!offw list` Show players inside whitelist
- `!!offw reload` Reload plugin itself

## 💾 Config

Location: `config/offline_whitelist.json`

```json
{
"whitelist_path": "./server/whitelist.json",
"minimum_permission_level": 2 // helper
}
```

## 🗂️ Required Python libraries

- [mcdreforged](https://github.com/Fallen-Breath/MCDReforged) >= 1.2.0

To install them execute:

```bash
pip install -r requirements.txt
```

0 comments on commit 63750eb

Please sign in to comment.