The following content is for developers or those curious about various features. If you are a regular user, you can skip to Step 3 without any issues.
Learn More
The executable file is named plazma-(version manager)-1.20.4-R0.1-SNAPSHOT-(mapping type).jar.
Mapping Type
Mapping is a kind of map that connects Minecraft's actual code with obfuscated code.
Reobf
Reobfuscated, also known as Spigot mapping, is used in most NMS plugins.
It will be discontinued starting from 1.20.5.
Mojmap
Mojang-mapped, vanilla Minecraft mapping.
Version Manager
The version manager can be considered as the launcher of the server, which is necessary for running the server and patching server files.
Paperclip
Developed by the PaperMC team for Paper and other derivative platforms, it downloads libraries and applies patches to the server.
Bundler
The vanilla Minecraft version manager.
3. Creating a Start Script
To easily start Plazma and automatically restart the server, you need to create a .
Flags.sh allows you to generate a startup script by entering only the in Plazma, the command will be automatically optimized.
You can download the start script by clicking the bottom left download button.
Make sure the downloaded start script matches your operating system.
4. File Cleanup
Now move the downloaded start script and Plazma to a new folder.
The folder name must not contain spaces and must be in English.
Otherwise, Plazma or JRE may not function correctly.
Now run the start script. For Windows, in the firewall permission prompt, make sure to select Allow.
5. EULA Agreement
Once you run the start script, an eula.txt file will be generated in the folder.
is a license agreement that you must agree to by using the services of .
If you do not agree, you cannot start the server, and if you violate the EULA, you may receive such as account suspension.
To agree to the EULA, change eula=false to eula=true in the eula.txt file and save it.
6. Allow External Connections (Windows)
Modern operating systems block external access by default to prevent unauthorized access from outside using firewalls and routers.
For Windows, since the firewall was allowed in Step 3, you just need to do port forwarding.
This guide assumes that it is written for Windows operating system and a router that can use .
If your router does not support UPnP, you will need to search for information as panel layouts vary by router.
Alternatively, you can use Ngrok to generate a temporary address.
For Linux or macOS (Unix-like) operating systems, firewall configuration methods vary by service, so you need to search for information directly.
If the output is True, you can stop here, but if it is False, you need to set up port forwarding.
6.2 Connect to the Server
If port forwarding is not needed or has already been successfully set up, you can now connect to the server.
The address used to connect to the server can be checked here
In the purpur.yml of the server folder, enable network.upnp-port-forwarding to true.
Then, when you restart the server, Plazma will automatically attempt port forwarding.
Below is the indication of UPnP success based on the message output to the console, which will be displayed as [UPnP] (message) in the console.
Message
Meaning
Successfully opened port (port)
Port forwarding successful.
Port (port) is already open
Another service is currently using that port.
Failed to open port (port)
Port forwarding failed.
Service is unavailable
The router does not support UPnP.
When the server shuts down, Plazma automatically closes the port.
Using Ngrok is useful for short-term testing, collaborative play, or playing with friends.
Download the Windows (64-bit) ZIP file from Ngrok website.
Put the downloaded Ngrok into the server folder.
Generate an authentication token at Ngrok dashboard.
Execute the command displayed in the Command Line in the server folder.
Add start /b ngrok tcp --region jp 25565 at the top of the execution script, and taskkill /f /t /im ngrok.exe at the bottom.
In the console, the address 0.tcp.jp.ngrok.io:12345 shown at the top will be the server's address.
Now you can connect from external sources using this address.
If you are trying to connect to the server from local, you can connect using the IPv4 address output from running cmd /k ipconfig in the command prompt.
For example, if the output displays as follows after executing the command,
