minecraft_plugins_v2/docs/Minecraft_Setup.md

# Server Setup

## Requirements

### Ports
* 255XY - Java Port
* 244XY - Voice Chat port
* 233XY - Bedrock Port

## Setup

### Config
1. In [this repo][config_01] create a new branch for the club/soc who wants the server.
2. Push this branch to Forgejo.

[config_01]: https://forgejo.skynet.ie/Skynet/minecraft_plugins_v2 

### Server
1. In the admin panel create a new server. [link][setup_01]
2. ``Information``
   * ``Primary Allocation``  
     * You will need to create allocations for both ports using the add allocation button   
       ![add_allocation.png][setup_02]
     * Add allocations for all 3 ports ``255XY``/``244XY``/``233XY``
   * ``Owner``
     * If the Club/Soc already has an account then use that
     * Else use the plus:   
       ![add_allocation.png][setup_02]  
       To create a new account for them.
       * ``username`` - This should be the Club/Soc as lowercase.  
         Check with Admin if they already have a Skynet account, if they have then use that.
       * ``email`` - use ``$username@skynet.ie`` or ``$username@ulwolves.ie``
         Do not use any other email.
3. ``Egg Configuration``
   * For the egg choose ``mcsleepingserverstarter-Packwiz-Purpur-Geyser-Floodgate``.
   * For ``{{PACKWIZ_URL}}`` it is ``https://forgejo.skynet.ie/Skynet/minecraft_plugins_v2/raw/branch/$BRANCHNAME/pack.toml``.
     * ``$BRANCHNAME`` is the name of the branch as done in [Config](#config).
4. Move onto ``Environment Configuration``
   * Memory give it about ``6144`` MB or so.
   * Swap Memory give it about ``1024``
   * ``Feature Limits`` give one or two backups.

[setup_01]: https://panel.games.skynet.ie/admin/servers/create
[setup_02]: media/add_allocation.png

### Minecraft
Now in the panel ye need to modify some files.  
If an option is not already in teh file then create it.

1. ``server.properties``
   * ``enforce-secure-profile=false`` - This allows bedrock players to talk in text chat
2. ``sleepingSettings.yml``
   * See the [Github repo][minecraft_01] for full config details
   * ``serverName`` - This is what gets shown on users server listings when teh server is sleeping.  
     ``GSoc, connect to wake up then reconnect in a min`` is what is on teh GSoc one,
   * ``serverPort`` - Use the Java port ``255XY``
   * ``bedrockPort`` - Use the Bedrock port ``233XY``
3. ``plugins/Geyser-Spigot/config.yml``
   * ``bedrock.port`` - Use the Bedrock port ``233XY``
4. ``plugins/voicechat/voicechat-server.properties``
    * ``port`` - Use the Voice port ``244XY``

[minecraft_01]: https://github.com/vincss/mcsleepingserverstarter

### DNS
An entry needs to be added to the [Forgejo DNS Config][dns_01] in the form of ``minecraft.$NAME``.  
Where ``$NAME`` is the name of teh club/soc, lowercase.

[dns_01]: https://forgejo.skynet.ie/Skynet/nixos/src/branch/main/applications/games/minecraft.nix#L27