Starting a Server - Revision history

Toketsupuurin: /* Hard(er) Way */

2020-06-25T21:59:28Z

‎Hard(er) Way

Toketsupuurin: /* Linux */

2020-06-25T21:57:52Z

‎Linux

Moonwolf: Added Protocol for port

2019-04-11T21:00:49Z

Added Protocol for port

Gdude2002: Add the rest of the command - need to check out a bunch, WIP

2018-01-30T10:15:01Z

Add the rest of the command - need to check out a bunch, WIP

Gdude2002: Alphabetize commands

2018-01-30T09:56:35Z

Alphabetize commands

Gdude2002: Alphabetize command-line args

2018-01-30T09:56:09Z

Alphabetize command-line args

Gdude2002 at 22:26, 27 January 2018

2018-01-27T22:26:55Z

Gdude2002: /* Installing Staxel with SteamCMD */

2018-01-27T20:37:28Z

‎Installing Staxel with SteamCMD

Gdude2002: /* Installing Staxel with SteamCMD */ Add missing req info

2018-01-27T20:35:52Z

‎Installing Staxel with SteamCMD: Add missing req info

Gdude2002: Server Wizard: Add Player Limit option

2018-01-27T19:14:41Z

Server Wizard: Add Player Limit option

@@ Line 172: / Line 172: @@
 === Hard(er) Way ===
-Another way is with steamcmd.  Not as easy as justy zipping it up, but some people like it hard. I don't judge.  Install steamcmd following the directions from https://developer.valvesoftware.com/wiki/SteamCMD#Linux
+Another way is with steamcmd.  Not as easy as just zipping it up, but some people like it hard. I don't judge.  Install steamcmd following the directions from https://developer.valvesoftware.com/wiki/SteamCMD#Linux
 Install Staxel with something like: steamcmd +login ACCOUNT_NAME PASSWORD +force_install_dir C:\steam\games\staxel +app_update 405710 +quit

← Older revision		Revision as of 21:57, 25 June 2020
Line 132:		Line 132:

	= Linux =		= Linux =
		+
		+	While the Staxel server does not have official Linux support, it is possible to at least get the server to run on Linux.
		+
		+	'''Please note:''' This is an unsupported setup. There may be stability issues. Additionally, the server will run slower, or possibly quite faster, than it would under Windows.
		+
		+	'''This is only recommended for advanced users!'''
		+
		+	This guide assumes that you're using Arch Linux, Ubuntu/Debian, or Centos/RedHat/Fedora, and that you know what you're doing - however, the instructions should also work for other Linux distributions.
		+
		+	== Requirements ==
		+
		+	# mono, which allows .Net applications to run under operating systems other than Microsoft Windows.
		+	# xvfb, only needed if you're running the server headless or otherwise without a gui.
		+
		+	=== Installing Requirements ===
		+
		+	Install the previously mentioned software packages with the following commands:
		+
		+	If running a DEB-based(Ubuntu, Debian, etc) distro, type:
		+	sudo apt-get install mono
		+	sudo apt-get install xvfb
		+
		+	If running an RPM-based(RedHat, Centos, Fedora, etc) distro, type:
		+	sudo yum install mono-core
		+	sudo yum install xorg-x11-server-Xvfb
		+
		+	If running an pacman-based(Archlinux, etc?) distro, type:
		+	sudo pacman -Sy mono
		+	sudo pacman -Sy xorg-server-xvfb
		+
		+	Note: In each case, xvfb is optional if you have a desktop display or gui, but doesn't hurt to have it anyway.
		+
		+	== Installing Server ==
		+
		+	=== Easy Way ===
		+
		+	You can just zip up the installation directory on windows and copy it over to linux and extract. This is SOO much easier than installing wine, and with it installing Steam or the stand-alone version, with all of their dependencies and whatnot. Just copy it. :P
		+
		+	=== Hard(er) Way ===
		+
		+	Another way is with steamcmd. Not as easy as justy zipping it up, but some people like it hard. I don't judge. Install steamcmd following the directions from https://developer.valvesoftware.com/wiki/SteamCMD#Linux
		+
		+	Install Staxel with something like: steamcmd +login ACCOUNT_NAME PASSWORD +force_install_dir C:\steam\games\staxel +app_update 405710 +quit
		+
		+	== Starting the server ==
		+
		+	Configuring your server from the command-line requires you to supply a set of command-line arguments whenever you start up the server.
		+	* '''--creative=(false\|true)''': Force Creative Mode to be turned on or off
		+	* '''--interface=0.0.0.0''': If you need to listen on a specific interface, you can supply it here - '''Advanced users only!'''
		+	* '''--local=(false\|true)''': Unknown at this time
		+	* '''--name=serverName''': Set the server name, used when public mode is <code>true</code>
		+	* '''--password=password''': Set a server password, used on connection
		+	* '''--playerlimit=4''': Limit the number of players that can be online at once
		+	* '''--port=38465''': Set the server port to listen for connections on
		+	* '''--public=(false\|true)''': Disable or enable public mode
		+	* '''--storage=localStorageName''': Set the name of the world to use here
		+	* '''--upnp=(false\|true)''': Set whether to attempt to use UPnP Port Forwarding
		+	* '''--weakAuthentication=(false\|true)''': Set whether to allow unauthenticated users to connect
		+
		+	Remember '''you do not have to supply every option''' - you can just supply what you need, and the rest will be defaulted.
		+
		+	You can omit "xvfb-run" if you are running the server on a system that has a desktop/gui, but it doesn't hurt to include it.
		+
		+	Make a sh file named something like "start.sh" and toss the following into it:
		+	mono ./bin/Staxel.Server.exe --creative=false --name=myFarm --password=potato --playerlimit=8 --port=38465 --public=false --storage=myFarm --upnp=false
		+	Make your script executable with:
		+	chmod u+x start.sh
		+	Now you can start your server with:
		+	xvfb-run start.sh
		+
		+	New method reported by [[User:Piousminion\|Piousminion]]
		+
		+	= Linux (Deprecated Method) =
		+
		+	This is an older method that has recently been reported to have issues. If the newer, recommended method gives you problems you can try this as a backup.

	While the Staxel server does not have official Linux support, it is possible to at least get the server to run on Linux.		While the Staxel server does not have official Linux support, it is possible to at least get the server to run on Linux.

@@ Line 3: / Line 3: @@
 The developers have stated that they're looking into Steam for multiplayer networking - but this may be some time coming, as they have a very long list of things to do!
-For reference, the default port for Staxel is '''38465'''.
+For reference, the default port for Staxel is '''38465''' TCP.
 '''If you're looking to start a server, please make sure you read all relevant sections before you start!'''

@@ Line 267: / Line 267: @@
 == Admin commands ==
-Administrators also get access to a set of admin commands:
+Administrators also get access to a set of admin commands - note that any arguments in <code>[square brackets]</code> are optional and can be left out
-* '''/fly''' - Enable flight
+* '''/advanceTime amount (0.0-0.1)''' - Advance time
-* '''/givepetals''' - Spawn in some extra money for a player
+* '''/ban username [reason]''' - Ban a user from your server
-* '''/noclip''' - Enables flight and allows you to fly through the ground and other solid objects
+* '''/cameraCapture camera_save_file_path''' - Unknown
 * '''/op username''' - Give someone else admin access, this will also allow them to do the tutorial with Farm Fan
-* '''/stealpetals''' - Take away money from a player
+* '''/pe expression_atlas [display_time]''' - Unknown
 * '''/tp player_1 player_2''' Teleport ''player_1'' to ''player_2''
 == Stopping the server ==
 When you're done with the server for now or just want to update it, simply press <code>CTRL + C</code> with the server terminal open. This will shut down the server. Please be patient, as the server will take a few moments to save everything!

@@ Line 270: / Line 270: @@
 * '''/fly''' - Enable flight
 * '''/givepetals''' - Spawn in some extra money for a player
 * '''/stealpetals''' - Take away money from a player
 == Stopping the server ==
 When you're done with the server for now or just want to update it, simply press <code>CTRL + C</code> with the server terminal open. This will shut down the server. Please be patient, as the server will take a few moments to save everything!

@@ Line 239: / Line 239: @@
 Configuring your server from the command-line requires you to supply a set of command-line arguments whenever you start up the server. They correspond with the settings found in the Server Wizard above, so look at that section for detailed information on what these settings do.
-* '''--public=(false|true)''': Disable or enable public mode
+* '''--creative=(false|true)''': Force Creative Mode to be turned on or off
 * '''--local=(false|true)''': Unknown at this time
 * '''--name=serverName''': Set the server name, used when public mode is <code>true</code>
 * '''--password=password''': Set a server password, used on connection
 * '''--port=38465''': Set the server port to listen for connections on
-* '''--interface=0.0.0.0''': If you need to listen on a specific interface, you can supply it here - '''Advanced users only!'''
+* '''--public=(false|true)''': Disable or enable public mode
 * '''--storage=localStorageName''': Set the name of the world to use here
 * '''--upnp=(false|true)''': Set whether to attempt to use UPnP Port Forwarding
 * '''--weakAuthentication=(false|true)''': Set whether to allow unauthenticated users to connect
 Remember '''you do not have to supply every option''' - you can just supply what you need, and the rest will be defaulted.

@@ Line 6: / Line 6: @@
 '''If you're looking to start a server, please make sure you read all relevant sections before you start!'''
 = Windows =
@@ Line 11: / Line 26: @@
 Staxel is designed with Windows in mind, and this is the easiest platform to host a server on.
-If you're inexperienced with server hosting or just want to play with your friends, this is the best option for you.
+If you're inexperienced with server hosting, this is the best option for you.
 == Requirements ==

@@ Line 169: / Line 169: @@
 # Run <code>./update_staxel.sh</code> and SteamCMD will download and install Staxel in <code>C:\staxel</code> on your Wine drive
 # Run <code>wine cmd</code> and then run <code>cd C:\staxel\_CommonRedist</code> to move to Staxel's requirements
-# Install the Visual C Redistributable with <code>vcredist\2013\vcredist_x64.exe /install /passive /norestart</code>
+# Install the Visual C Redistributable with <code>vcredist\2013\vcredist_x64.exe /install /quiet /norestart</code>
 # Install XNA with <code>msiexec /quiet /i XNA\4.0\xnafx40_redist.msi</code>
 # '''Do not''' install DirectX or DotNet - Installing the latter will completely break your install

@@ Line 168: / Line 168: @@
 # Run <code>chmod +x update_staxel.sh</code> to mark the script you just made as executable
 # Run <code>./update_staxel.sh</code> and SteamCMD will download and install Staxel in <code>C:\staxel</code> on your Wine drive
 # Move to the [[#Starting_the_server|Starting the server]] section

@@ Line 199: / Line 199: @@
 * '''Server Name''': The name of your server on the public server list - if you've turned off the Public option, this will be unavailable
 * '''Port''': The port to listen for connections on - this defaults to 38465, and you shouldn't need to change it under normal circumstances
 * '''Password''': If you want to prevent people from connecting without a password, you can enter that password here
 * '''Allow unauthenticated players''': If you enable this, players that are playing the game in offline mode may connect to the server. This will be greyed out if the server is public. '''It's not recommended that you enable this as it can make your server insecure'''