| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| minecraft [2019/05/06 21:54] – jnilsson | minecraft [2019/05/14 16:30] (current) – justip6 |
|---|
| * **IP Address**: **128.195.133.148** | * **IP Address**: **128.195.133.148** |
| |
| * **User accounts**: with SS2K domain account or local user "**mcuser**" (ask sscs@uci.edu if you do not know the password) | * **User accounts**: local user "**mcuser**" (ask sscs@uci.edu if you do not know the password). Specific SS2K domain accounts can also be setup to login. |
| |
| * **Local group**: "**mc-research**" is setup with write access to the necessary directories for managing spigot and minecraft server instances. The mcuser and certain domain accounts are setup as members of this group. | * **Local group**: the group "**mc-research**" is setup with write access to the necessary directories for rebuilding spigot and managing minecraft server instances. The mcuser and certain domain accounts are setup as members of this group. |
| |
| ===== Important directories on the server ===== | ===== Important directories on the server ===== |
| * ''**spigot-build.sh [version]**'' - rebuild the spigot.jar, optionally to a specified version number | * ''**spigot-build.sh [version]**'' - rebuild the spigot.jar, optionally to a specified version number |
| * ''**start-mc.sh [port]**'' - start a new minecraft server instance on a random port, or the optionally specified port | * ''**start-mc.sh [port]**'' - start a new minecraft server instance on a random port, or the optionally specified port |
| | |
| | |
| |
| ===== Important screen commands ===== | ===== Important screen commands ===== |
| |
| When the start-mc.sh script starts a minecraft instance, it runs it in a screen so you can connect to the server console later to check it or to give it the "stop" command | When the start-mc.sh script starts a minecraft instance, it runs it in a screen so you can connect to the server console later to check it or to give it the "stop" command |
| | |
| | Send server to background without shutting down the server |
| | * Simply exiting the terminal window or putty session |
| | * ''Ctrl+a'' then ''d'' (Press ctrl+a, let go, then press d) |
| |
| screen names will be of the format "''mc-<port>''" | screen names will be of the format "''mc-<port>''" |
| * ''%%screen -r mc-<port>%%'' - reconnect to the screen named ''mc-<port>'' which corresponds to the minecraft instance listening on that port number | * ''%%screen -r mc-<port>%%'' - reconnect to the screen named ''mc-<port>'' which corresponds to the minecraft instance listening on that port number |
| * ''%%screen -dr mc-<port>%%'' - forcibly disconnect existing connections to the screen, and reconnect, essentially taking over all other connections | * ''%%screen -dr mc-<port>%%'' - forcibly disconnect existing connections to the screen, and reconnect, essentially taking over all other connections |
| | |
| | |
| | ===== Setup the template directory ===== |
| | |
| | The directory ''/usr/local/mc-research/template'' is the template directory that will get used to create new instances of minecraft when you run the script ''start-mc.sh''. You should customize this template as needed. |
| | |
| | * Edit the file ''/usr/local/mc-research/template/server.properties'' to meet your needs (change settings like gamemode, difficulty, allow-flight, etc) |
| | * Upload the world directory (in the current template, the "test" directory is the saved world), and make sure the setting "level-name" in ''server.properties'' is set to the name of your world directory. |
| | * Make sure there is a ''eula.txt'' file in the template directory, with the setting ''eula=TRUE'' (this should already be there, unless you replace the entire template directory). |
| | * ensure there is a spigot.jar file or valid symlink |
| | |
| |
| |
| === Output: spigot-<version>.jar === | === Output: spigot-<version>.jar === |
| The result of this script is a file called ''%%spigot-<version>.jar%%'' where <version> is the actual version number. If the script is able to, it will try to copy this file into the TEMPLATE directory used by the ''%%start-mc.sh%%'' script (see below), and setup a symlink to it called just "spigot.jar". | The result of this script is a file called ''%%spigot-<version>.jar%%'' where <version> is the actual version number. If the script is able to, it will try to copy this file into the TEMPLATE directory used by the ''%%start-mc.sh%%'' script (see below), and setup a symlink to it called just "spigot.jar". |
| | |
| | * **NOTE**: the ''spigot-build.sh'' script will NOT automatically update the spigot-<version>.jar file in any existing minecraft instances. You will have to manually stop any running instances and update the spigot.jar symlink (see below) |
| |
| == Old versions of spigot == | == Old versions of spigot == |
| Old versions of the file spigot-<version>.jar are saved in an "old" directory under ''/usr/local/spigot''. If needed, you can look there for a specific version number rather than rebuilding it. You would have to copy the desired version into the specific minecraft instance location, or to the template if you want to update the template, and then create a spigot.jar symlink pointing to it. | Old versions of the file spigot-<version>.jar are saved in an "old" directory under ''/usr/local/spigot''. If needed, you can look there for a specific version number rather than rebuilding it. You would have to copy the desired version into the specific minecraft instance location, or to the template if you want to update the template, and then create a spigot.jar symlink pointing to it. |
| |
| === spigot.jar symlink === | === Update spigot.jar symlink === |
| | |
| | The minecraft template directory and each specific instance under the named <port> directories must have a spigot.jar symlink (a symbolic link) that points to the desired version of the file. |
| |
| The minecraft template directory and each specific instance under the named <port> directories must have a spigot.jar symlink (a symbolic link) that points to the desired version of the file. For example, you might have a spigot-1.13.2.jar file and a spigot-1.14.jar file, but whichever one spigot.jar points to is the one that will be loaded:<code> | For example, you might have a spigot-1.13.2.jar file and a spigot-1.14.jar file, but whichever one spigot.jar points to is the one that will be loaded:<code> |
| # change directory to the template directory (where you want to copy the new spigot-version.jar file to) | # change directory to the template directory (where you want to copy the new spigot-version.jar file to) |
| cd /usr/local/mc-research/template | cd /usr/local/mc-research/template |
| The port range 25570 to 25599 is hard coded into the script as the valid port range to use for running minecraft spigot servers. These ports are opened in the system firewall to allow incoming connections. If a different port range is required, then the script must be updated and the system firewall must be updated to match. | The port range 25570 to 25599 is hard coded into the script as the valid port range to use for running minecraft spigot servers. These ports are opened in the system firewall to allow incoming connections. If a different port range is required, then the script must be updated and the system firewall must be updated to match. |
| |
| ==== How to setup the template ==== | |
| |
| Before running ''start-mc.sh'', you should setup the template as needed. | |
| |
| * Edit the file ''/usr/local/mc-research/template/server.properties'' to meet your needs (things like gamemode, difficulty, allow-flight, etc) | |
| * Upload the world directory (in the current template, the "test" directory is the saved world), and make sure the setting "level-name" in ''server.properties'' is set the name of your world directory. | |
| * Make sure there is a ''eula.txt'' file in the template directory, with the setting ''eula=TRUE'' | |
| |
| ==== How to run start-mc.sh ==== | ==== How to run start-mc.sh ==== |
| <code>start-mc.sh 25570</code> | <code>start-mc.sh 25570</code> |
| |
| ===== How to manage minecraft instances ===== | |
| | |
| | |
| | |
| | ===== FAQ: How to manage minecraft instances ===== |
| |
| === How to see currently running instances === | === How to see currently running instances === |
| If a minecraft instance is already running as shown by ''screen -list'', then you can reconnect to it to stop it or otherwise interact with it. For example, if ''screen -list'' shows the screen name "mc-25570" is running, then I use this command to connect to it: | If a minecraft instance is already running as shown by ''screen -list'', then you can reconnect to it to stop it or otherwise interact with it. For example, if ''screen -list'' shows the screen name "mc-25570" is running, then I use this command to connect to it: |
| <code>screen -dr mc-25570</code> | <code>screen -dr mc-25570</code> |
| | |
| | === How to disconnect from minecraft server screen without stopping it === |
| | |
| | You can safely close your PuTTY or Terminal session, and minecraft will continue to run. Or you can disconnect from the screen and return to your command prompt using ''Ctrl + a, d'' (hold the ''Ctrl'' key and press ''a'', release both keys, then press ''d''). |
| |
| === How to stop an instance === | === How to stop an instance === |
| mv /usr/local/mc-research/25570 ~/archive/20190506-jnilsson-exp1 | mv /usr/local/mc-research/25570 ~/archive/20190506-jnilsson-exp1 |
| </code> | </code> |
| | |
| | === If you accidentally type ''screen'' without any arguments === |
| | Screen will tell you at the bottom of the terminal: [Press Space or Return to end.] |
| | |
| | Do so, and when the terminal clears, type exit |
