diff --git a/docs/compiling.mdx b/docs/compiling.mdx index 60ab177..eb11eae 100644 --- a/docs/compiling.mdx +++ b/docs/compiling.mdx @@ -7,7 +7,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; # Compiling -Compiling Plex is straightforward as there are no dependencies that need to be added manually. Plex uses Gradle as the build system. All compiling instructions are in the ```build.gradle``` file. Note that you can download an already compiled version of Plex from the [CI Server](https://ci.plex.us.org). +Compiling Plex is straightforward as there are no dependencies that need to be added manually. Plex uses Gradle as the build system. All compiling instructions are in the ```build.gradle.kts``` file. Note that you can download an already compiled version of Plex from the [CI Server](https://ci.plex.us.org). ## Prerequisites Please ensure that you have Java 17 installed on your computer, as Plex requires JDK 17 to compile. You will get an error if you try to use an older version. @@ -34,24 +34,30 @@ Gradle is already included in the folder with Plex. Run the following command be - ./gradlew build +```bash +./gradlew build +``` - gradlew.bat build +```bash +gradlew.bat build +``` - ./gradlew build +```bash +./gradlew build +``` -You should receive a message indicating the compilation was successful. The JAR files for the Server, API, and Proxy are located in the `build/libs` folder. +You should receive a message indicating the compilation was successful. The JAR files for the Server and Proxy are located in the `build/libs` folder. -Plex has no external dependencies and can be used right away after compilation. Plex works on Minecraft 1.18.2. You also must be running Java 17 on the server itself. +Plex has no external dependencies and can be used right away after compilation. Plex works on Minecraft 1.19 to 1.20.4. You also must be running Java 17 on the server itself. ## Troubleshooting If you receive an error that says Permission denied, run `chmod a+x gradlew`. Note that this only applies to macOS / Linux users. diff --git a/docs/redis.md b/docs/redis.md index 054fb09..b3a9572 100644 --- a/docs/redis.md +++ b/docs/redis.md @@ -80,3 +80,6 @@ side: ``` Replace `your_secure_password_here` with the password you made for Redis. Now, Plex will use Redis for storing punishment data. Note that the JSON files are still made as a backup no matter what. + +### Firewall Configuraton +If you are using a firewall, you may have to allow port `6380`. It is safe to allow connections from anywhere provided you have followed the documentation correctly. diff --git a/docs/versions.md b/docs/versions.md index 7bb7090..1c0a382 100644 --- a/docs/versions.md +++ b/docs/versions.md @@ -8,7 +8,7 @@ Plex builds against the latest Minecraft version available. A table has been pro | Plex Version | Minecraft Versions | | ------------ | ------------------ | -| 1.3 | 1.19.4 - 1.20.1 | +| 1.3 | 1.19.4 - 1.20.4 | | 1.2 | 1.18.2 - 1.19.2 | | 1.1.1 | 1.18.2 - 1.19.2 | | 1.1 | 1.18.2 |