Minecraft Documentation

knowledgebase/game_servers/minecraft/changing_server_icon.md

@@ -0,0 +1,18 @@
+---
+id: changing_server_icon
+title: Changing the server Icon
+description: How to change the server icon that displays on the multiplayer server list.
+---
+A server icon is a picture or logo that shows up on the left side of the server name in your Minecraft client's multiplayer list.
+
+## Preparing the image
+Before setting up a server icon on your server you will need an image, for which there are a few requirements.
+- The image size must be 64 pixels by 64 pixels
+- The file type must be a `.png`
+- The file name must be `server-icon`
+
+## Setting up the icon
+After preparing your image, follow the below steps to setup your server icon.
+1. After prepairing your image, upload it to your Minecraft server using either the Panel file manager or a SFTP client like [FileZilla](/knowledgebase/game_servers/tutorial_filezilla_sftp).
+2. Upload the `server-icon.png` file inside the root directory (/home/container)
+3. After uploading the icon file, go back to the console tab and restart the server to apply the server-icon changes.

knowledgebase/game_servers/minecraft/changing_version.md

@@ -0,0 +1,28 @@
+---
+id: changing_version
+title: Changing the Minecraft Version
+description: How to change and update the server with a different Minecraft version.
+---
+
+## Changing the Version
+:::danger
+We highly encourage making a backup of the server before switching version, data may be lost and **going back versions is not supported and will cause world corruptions.**
+:::
+
+1. Navigate to the [Game Panel](https://hrzn.link/panel) and select the server you wish to use.
+2. Locate and navigate to the server startup section and locate the **Minecraft Version** field.
+3. Replace the **Minecraft Version** with a valid server version, for example **1.16.4** or **1.8.8**
+4. Navigate to the settings page and press the **Reinstall** button.
+
+## Changing server type
+To change your server type, for example changing `PaperMC -> Forge`, please make a [support request](/knowledgebase/getting_support), and we will handle this for you.
+
+## Common Issues
+### Invalid Java Version
+If the server fails to start and the console outputs something along the lines of ``Minecraft x.xx requires running the server with Java xx or above.`` Then it means your server is using the wrong Java version and the version of Minecraft you are using does not support the Java version you are trying to use it with. To fix this follow the steps below:
+1. Navigate to the startup startup section and locate the **Docker Image** field.
+2. Select the correct Docker image that matches your server version as below.
+    - **Minecraft version 1.8** use `ghcr.io/pterodactyl/yolks:java_8` or any version after
+    - **Minecraft version 1.12** use `ghcr.io/pterodactyl/yolks:java_11` or any version after
+    - **Minecraft version 1.17** use `ghcr.io/pterodactyl/yolks:java_16` or any version after
+    - **Minecraft version 1.18** use `ghcr.io/pterodactyl/yolks:java_17` or any version after

knowledgebase/game_servers/minecraft/create_timings_report.md

@@ -0,0 +1,16 @@
+---
+id: create_timings_report
+title: Create a timings report
+description: How to create a timings report to diagnose and identify issues.
+---
+Please ensure that your timings report is captured during a period of server lag and that it spans at least ten minutes. This will only work for Spigot and Paper servers.
+
+## What is a timings report for?
+When opening a support request for server lag or issues, we will often request a timings report from you. This allows us to identify issues or why your server is lagging.
+
+## How to create a timings report
+1. Start your server and let it run
+2. When your server is lagging you can run `/timings on` or `timings on` in console.
+3. Capture a timings report for around 10-15 minutes, the report is being generated in the background.
+4. After 10-15 minutes you can execute `/timings report` or `timings report` in console.
+5. The server will feedback a link to you, this is the timings report.

knowledgebase/game_servers/minecraft/erasing_the_server.md

@@ -0,0 +1,14 @@
+---
+id: erasing_the_server
+title: Erasing a Minecraft Server
+description: How to erase and start fresh on a Minecraft Server
+---
+
+Following this guide will erase all player data, world, bans and all other persistant data on your Minecraft server, only follow this guide if you want to do this.
+
+## How to erase the server
+1. Navigate to the [Game Panel](https://hrzn.link/panel) and select the server you wish to use.
+2. Locate and navigate to the file manager page
+3. Select all files and press Delete
+4. Confirm Deletion
+5. Navigate to the settings page and press the **Reinstall** button.

knowledgebase/game_servers/minecraft/how_much_ram.md

@@ -0,0 +1,38 @@
+---
+id: how_much_ram
+title: How much ram do I need?
+description: Learn how much ram you need for your Minecraft server and which plan is right for you.
+---
+Various amounts of RAM will be needed for different Minecraft servers depending on their setup and intended use. A Minecraft server's performance will suffer or even crash if it has less RAM than it requires, so it's critical to know what factors influence RAM usage and how much is required. A server will typically require more RAM the more players and addons (mods/plugins) it supports.
+
+A reminder that the following values are only a suggestion and its always better to have more RAM.
+
+## Vanilla / Spigot / Paper
+Vanilla server normally use less RAM then Spigot/Paper servers as they dont use plugins however there is a few variables to keep in mind when calculating RAM which are listed below.
+
+| Variable | Reccomended RAM |
+|----------|-----------------|
+|Minecraft 1.16.4 or previous versions|3GB|
+|Minecraft 1.17+|4GB|
+|For every 5 additional players|+1GB|
+|For every 10 additional plugins|+1GB|
+
+## BungeeCord / Velocity
+BungeeCord and Velocity servers use an extremely low amount of RAM, we recommend **500MB** as a base value however this should be increased depending on players and plugins.
+
+| Variable | Reccomended RAM |
+|----------|-----------------|
+|BungeeCord / Velocity|500MB|
+|For every 5 plugins|+500MB|
+|For every 200 additional players|+1GB|
+
+## Forge / Fabric
+Forge and Fabric servers use a huge amount of RAM as they fully customize the game, the suggestions for amounts are listed below.
+
+| Variable | Reccomended RAM |
+|----------|-----------------|
+|Minecraft 1.12.2 or previous versions|3GB|
+|Minecraft 1.13 - 1.16.4|4GB|
+|Minecraft 1.17+|5GB|
+|For every 5 additional players|+1GB|
+|For every 10 additional mods|+1GB|

knowledgebase/game_servers/minecraft/installing_mods.md

@@ -0,0 +1,24 @@
+---
+id: installing_mods
+title: Installing server mods
+description: How to install server mods on your server
+---
+To install Fabric or Forge mods on your server you need to download the mod `.jar` file you wish to use and then upload it to the server, this guide will explain how to do this.
+
+:::note
+Even though both [CurseForge](https://www.curseforge.com/minecraft) and [Modrinth](https://modrinth.com/) are reputable sites, malware is still occasionally uploaded. Please be cautious with what you are downloading and using.
+:::
+
+## Where can I find mod files?
+You are able to find mods published at many different places, some of these locations include [CurseForge](https://www.curseforge.com/minecraft) and [Modrinth](https://modrinth.com/) however there is many more sites available.
+
+When downloading a mod file you must also ensure the following applies
+- The file is the correct Minecraft version and the same as your server.
+- You also download any dependancies that the mod needs, these are usually listed on the mods page.
+- You ensure that the mod if for the correct mod loader Forge/Fabric
+
+## Installing a mod
+1. You need to obtain the mod file for example `EXAMPLE_PLUGIN.jar` and ensuring its using the correct Minecraft version that you are running your server with.
+2. Once obtaining the jar file you can upload it to your Minecraft server using either the panel file manager or an SFTP client like [FileZilla](/knowledgebase/game_servers/tutorial_filezilla_sftp).
+3. Upload the plugin file inside the directory named `mods`
+4. After uploading the jar file you can go back to the console tab and restart the server.

knowledgebase/game_servers/minecraft/installing_plugins.md

@@ -0,0 +1,18 @@
+---
+id: installing_plugins
+title: Installing plugins
+description: How to install plugins on your minecraft server.
+---
+Minecraft servers such as Spigot or Paper are able to run plugins which modify the experience within the server. Plugins come in many different forms and this guide explains how to setup and install plugins on your server.
+
+## Where can I find plugins?
+You are able to find plugins published at many different places, some of these locations include [SpigotMC](https://www.spigotmc.org/) and [Hangar](https://hangar.papermc.io/) however there is many more sites available.
+:::note
+Even though both [SpigotMC](https://www.spigotmc.org/) and [Hangar](https://hangar.papermc.io/) are reputable sites, malware is still occasionally uploaded. Please be cautious with what you are downloading and using.
+:::
+
+## Installing a plugin
+1. You need to download the plugin file and after ensure it's built for the same Minecraft version that your  server is running.
+2. Once obtaining the jar file you can upload it to your Minecraft server using either the panel file manager or a SFTP client like [FileZilla](/knowledgebase/game_servers/tutorial_filezilla_sftp).
+3. Upload the plugin file inside the directory named `plugins`
+4. After uploading the jar file you can go back to the console tab and restart the server.

knowledgebase/game_servers/minecraft/plugins/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "Plugins",
+    "position": 1,
+    "link": {
+      "type": "generated-index"
+    }
+}

knowledgebase/game_servers/minecraft/plugins/dynmap.md

@@ -0,0 +1,30 @@
+---
+id: dynmap
+title: Dynmap Setup
+description: How to install Dynmap on your Minecraft server.
+---
+A Google Maps-like map for your Minecraft server that can be viewed in a browser. Easy to set up when making use of Dynmap's integrated webserver which works out-of-the-box, while also available to be integrated into existing websites running on Apache and the like. Dynmap can render your worlds using different renderers, some suitable for performance, some for high detail.
+
+## Installation
+1. Go to the [download page](https://modrinth.com/plugin/dynmap/versions) for Dynmap
+2. Locate the latest version that supports your server version and type and download the `dynmap-*.jar` file
+3. Once obtaining the dynmap jar file you can upload it to your Minecraft server using either the pterodactyl file manager or a SFTP client like [FileZilla.](/knowledgebase/game_servers/tutorial_filezilla_sftp)
+4. Upload the plugin file inside the relevant directory either `plugins` or `mods`
+5. After uploading the jar file you can go back to the console tab and restart the server
+
+## Setup Guide
+1. Navigate to your server on the panel
+2. Stop the server inside the console tab of your server
+3. Navigate to Network, and create a new allocation
+4. Note down the IP Address and Port of the new allocation you just created
+5. Using either the pterodactyl file manager or a SFTP client like [FileZilla.](/knowledgebase/game_servers/tutorial_filezilla_sftp) locate the `dynmap` folder inside of the `plugins` folder
+6. Locate and open the `configuration.txt` file
+7. In the `configuration.txt` find the line that says `deftemplatesuffix: hires` and replace this with `deftemplatesuffix: vlowres` or `deftemplatesuffix: lowres`.
+8. Next locate the line that says `webserver-port: 8123` and replace this with `webserver-port: <port from step 4>`
+9. Save changes to the `configuration.txt`
+10. Go back to the console tab on your server and click **start**
+11. Once the Minecraft server fully starts up, your Dynmap server should be live at `http://IP:PORT` making sure to replace `IP` and `PORT` with the relevant values from step 4.
+
+## Common Issues
+### Webpage Not Loading
+If you are having issues with the webpage not loading, please ensure your using `http://IP:PORT` and not `https://IP:PORT` if after that its still not working please open a [support request](/knowledgebase/getting_support) and we will be able to assist you.

yarn.lock

@@ -4023,6 +4023,11 @@ fs.realpath@^1.0.0:
   resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
   integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==
 
+fsevents@~2.3.2:
+  version "2.3.2"
+  resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz"
+  integrity sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==
+
 function-bind@^1.1.1:
   version "1.1.1"
   resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz"