mrkrk/portable-mc-server
1
0
Fork 0
mirror of https://github.com/grey-cat-1908/portable-mc-server.git synced 2024-11-11 18:57:27 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme

Browse source
This commit is contained in:
grey-cat-1908 2024-01-31 16:23:12 +03:00
parent a48a09748e
commit 8b848a8125
1 changed files with 21 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -28,13 +28,21 @@ You can configure nearly everything by setting up the following Enviroment Varia
| Variable | Description | Value | | Variable | Description | Value |
|---|---|---| |---|---|---|
| `RAM` | How much RAM do you want to allocate to the server? | `1G` (default) | | `RAM` | How much RAM do you want to allocate to the server? | `1G` (default) |
| `MC_VERSION` | What version of Minecraft do you want to install? | `1.20` (default) | | `MC_VERSION` | What version of Minecraft do you want to install? | `1.20.4` (default) |
| `MC_SERVER` | Which server should be installed automatically? (only `pufferfish`, `purpur`, `patina` are supported) | `purpur` (default) |
| `SSH_PASSWORD` | SSH password | `admin` (default) | | `SSH_PASSWORD` | SSH password | `admin` (default) |
| `FORCE_REINSTALL` | Would you like to reinstall your server? `1` - yes; `0` - no | `0` (default) |
**NOTE:** You can set Environment Variable within balenaCloud. On the left, simply click on “Device Variables” and then click the “Add Variable” button. Give it a name, and set the value. **NOTE:** You can set Environment Variable within balenaCloud. On the left, simply click on “Device Variables” and then click the “Add Variable” button. Give it a name, and set the value.
**NOTE:** You can also delete everything on the server and automatically reinstall it. On the left, simply click on “Actions” and then click the “Purge Data” button. Insert `1` and click “Purge Data”.
![set variable demonstration](https://cdn.arbuz.icu/img/balena/balenaSetVariables.png) ![set variable demonstration](https://cdn.arbuz.icu/img/balena/balenaSetVariables.png)
## Using RCON
... ToDo...?
## Connecting to the server using SFTP ## Connecting to the server using SFTP
I recommend using FileZilla to connect to the server via SFTP. I recommend using FileZilla to connect to the server via SFTP.
@ -45,6 +53,18 @@ I recommend using FileZilla to connect to the server via SFTP.
Once the connection is established, remember to navigate to the `/usr/src/mcfiles` directory. Once the connection is established, remember to navigate to the `/usr/src/mcfiles` directory.
## Changing server
Purpur is automatically installed the first time you run it. If you want to change it, you can set the environment variable `MC_SERVER`. (See the configuration section for more details.) Remember to reinstall the server afterwards (set `FORCE_REINSTALL` environment variable to `1`).
**NOTE:** Please note that `pufferfish` versions can only take integer values, i.e.: `1.19`, `1.20` can be specified; `1.20.4` cannot be specified, the game will not start. If you specify version `1.20`, you will be able to play with `1.20.4`.
| Server | `MC_SERVER` value |
| --- | --- |
| [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) | `pufferfish`
| [Patina](https://github.com/PatinaMC/Patina) | `patina`
| [Purpur](https://purpurmc.org/) | `purpur`
## Installing plugins ## Installing plugins
... ToDo...? ... ToDo...?