diff options
| author | destruc7i0n <dscdsouza@outlook.com> | 2020-02-11 15:43:44 -0500 |
|---|---|---|
| committer | destruc7i0n <dscdsouza@outlook.com> | 2020-02-11 15:43:44 -0500 |
| commit | 8e9349f354c65681a808aaa27c2a8d4edbdb1c1a (patch) | |
| tree | ad3c10f0330c14ba8aa893cc355e9350a9c98175 /README.md | |
| parent | Merge pull request #47 from destruc7i0n/refactor (diff) | |
| download | shulker-8e9349f354c65681a808aaa27c2a8d4edbdb1c1a.tar.gz shulker-8e9349f354c65681a808aaa27c2a8d4edbdb1c1a.zip | |
Update README.md
Diffstat (limited to '')
| -rw-r--r-- | README.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md index 64abf69..fe48837 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ > Connects [Discord](https://discordapp.com/) and [Minecraft](https://minecraft.net) Servers by sending messages back and forth without any mods or plugins. +## Notice +This project has recently gone under a rewrite and the format for `config.json` is not directly backwards compatible with previous versions. +See [below](#upgrade-instructions) for details. + ## In Action  @@ -97,6 +101,11 @@ You can also easily Deploy to Heroku and the like, just be sure to edit `YOUR_UR - Make sure that you have a role on the server which is put in the array `SLASH_COMMAND_ROLES` case-sensitive. - e.g. `"SLASH_COMMAND_ROLES": ["Admin"]` +## Upgrade Instructions +From version 2 to version 3: +- The main change is that you need to split your `REGEX_MATCH_CHAT_MC` to both `REGEX_MATCH_CHAT_MC` and `REGEX_SERVER_PREFIX`. + See the [configuration](#configuration) above for details. + ## Upcoming None |