Plexus/Website
1
0
Fork 0
mirror of https://github.com/plexusorg/Website.git synced 2024-11-16 17:36:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

update some pages

Browse Source
This commit is contained in:
root 2024-01-10 23:00:03 +00:00
parent f807200dfe
commit d3f95a228a
3 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/compiling.mdx
View File

@ -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
<Tabs>
<TabItem value="macOS" label="macOS" default>
```bash
./gradlew build
```
</TabItem>
<TabItem value="Windows" label="Windows">
```bash
gradlew.bat build
```
</TabItem>
<TabItem value="Linux" label="Linux">
```bash
./gradlew build
```
</TabItem>
</Tabs>
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.

3
docs/redis.md
View File

@ -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.

2
docs/versions.md
View File

@ -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 |