Added README.md

This commit is contained in:
Jack 2024-07-29 16:02:39 +01:00
parent 14c6ee1d03
commit 8a4276a8f2
1 changed files with 20 additions and 0 deletions

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# Network
A free network plugin that uses redis pub-sub to connect each server and provide server monitor messages.
### Setup
1. Add Network-{version}-SNAPSHOT.jar to your plugins folder from the releases tab.
2. Start the server.
3. 1. Locate the config in `plugins/Network/config.yml`
2. Set your Redis host and port
3. Set your server name `⚠️ Make sure that all server names are unique`
4. Start your server.
### Default Config
```
REDIS:
HOST: "172.17.0.1"
PORT: 6379
PASSWORD: ""
SERVER-NAME: "Hub-01"
```