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

Custom build URL short guide

Browse source
This commit is contained in:
mrkrk 2024-08-31 15:35:53 +03:00 committed by GitHub
parent 2193849d7a
commit eb4b682f9d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -66,10 +66,11 @@ You can configure nearly everything by setting up the following Enviroment Varia
|---|---|---| |---|---|---|
| `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.21.1` (default) | | `MC_VERSION` | What version of Minecraft do you want to install? | `1.21.1` (default) |
| `MC_SERVER` | Which server should be installed automatically? (only `pufferfish`, `purpur`, `paper` are supported) | `paper` (default) | | `MC_SERVER` | Which server should be installed automatically? (only `pufferfish`, `purpur`, `paper`, `custom` are supported) | `paper` (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) | | `FORCE_REINSTALL` | Would you like to reinstall your server? `1` - yes; `0` - no | `0` (default) |
| `SUPPORT_BEDROCK` | Would you like to add support for Minecraft Bedrock users? `1` - yes; `0` - no | `0` (default) | | `SUPPORT_BEDROCK` | Would you like to add support for Minecraft Bedrock users? `1` - yes; `0` - no | `0` (default) |
| `CUSTOM_BUILD_URL` | Custom build URL. Only applies if you set the `MC_SERVER` value to `custom` | - |
**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.
@ -77,7 +78,6 @@ You can configure nearly everything by setting up the following Enviroment Varia
**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”. **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”.
## Using RCON ## Using RCON
You can connect to your server console using Minecraft RCON. You only need server IP-address, RCON port (usually default) and RCON password (you should change it in server.properties, but default is admin). You can connect to your server console using Minecraft RCON. You only need server IP-address, RCON port (usually default) and RCON password (you should change it in server.properties, but default is admin).
@ -106,6 +106,8 @@ Purpur is automatically installed the first time you run it. If you want to chan
| [Purpur](https://purpurmc.org/) | `purpur` | [Purpur](https://purpurmc.org/) | `purpur`
| [Paper](https://papermc.io/) | `paper` | [Paper](https://papermc.io/) | `paper`
You can also set the `MC_SERVER` value to `custom`, but then you must also set the `CUSTOM_BUILD_URL` environment variable. Maybe someone has already done this and written instructions. I suggest you look for the instructions [here](https://github.com/grey-cat-1908/portable-mc-server/issues) or try to do that by yourself.
## Installing plugins ## Installing plugins
You can install your plugins by connecting to the server via SFTP. Download the plugins you need from reliable sites (`hangar.papermc.io`, `spigotmc.org` or official plugin sites). Put them in the plugins directory and restart the server. (e.g. with RCON (command `restart`) or by restarting the minecraft service on balenaCloud). You can install your plugins by connecting to the server via SFTP. Download the plugins you need from reliable sites (`hangar.papermc.io`, `spigotmc.org` or official plugin sites). Put them in the plugins directory and restart the server. (e.g. with RCON (command `restart`) or by restarting the minecraft service on balenaCloud).
@ -120,7 +122,9 @@ Remember to restart yor server (e.g. with RCON (command `restart`) or by restart
## Mods...? ## Mods...?
Mods are not supported at the moment and I don't see the point in doing so. My understanding is that servers with mods are not very common, more complicated to use (everyone has to have the same mod version and so on) and more demanding on resources (I am not sure Raspberry Pi can handle it). Mods are not supported at the moment, and I don't see the point. As far as I know, servers with mods are not very common, are more difficult to use (everyone has to have the same mod version, etc.), and are more resource intensive (not sure if the Raspberry Pi can handle it).
**NOTE:** However, you could try installing mods using the `custom` server installation option. If you know how to do that, you can post a complete installation guide for beginners [here](https://github.com/grey-cat-1908/portable-mc-server/issues). You will probably help a lot of people, and support for this type of server may be added in the future.
## Bedrock Support ## Bedrock Support