8/23/2021

Starbound How To Install Mods On Server

26

Starbound does not support controllers, so you will need multiple keyboards and mice.

  • If you've installed Starbound via GOG Galaxy: Galaxy directory Games Starbound. Open the folder named mods. Paste your mod into the folder. If the mod has.pak file, paste it right there. If the mod doesn't have.pak file but has folder with the name of the mod (e.g. 'Dungeon Mod'), paste the whole folder.
  • Login to your server FTP. On the remote site, navigate inside the starbound directory. Right click on the remote site and create a directory named mods. Enter the mods directory.

Video tutorial

Starbound Server Setup Guide Starbound dedicated server setups can work on both Windows or Linux systems. It is heavily configurable and depending on what you want can take a bit of effort and google foo to get everything running correctly.

Starbound setup

  1. Open the Starbound directory by right-clicking Starbound in Steam -> Properties -> Local files -> Browse game files…

  2. Go to Starboundwin64 (or Starboundwin32 if you have a 32bit computer). Launch starbound.exe as many times you need. Resize the windows however you like.

  3. Start a world on one instance. Make sure IP joinable is enabled in the pause menu options. On the others, go to Join game -> Choose a (different) character -> Set 127.0.0.1 as the server address and leave the port, account and password boxes empty.

Tips before you start

  1. If you have inconsistent mouse movement, especially when moving multiple mice, make sure the polling rates on your mice are set as low as possible. You can usually set this in your mouse configuration program (look on the manufacturer’s website).

  2. Disable steam overlay by right-clicking Starbound in Steam -> Properties and un-check ‘Enable the Steam Overlay while in-game’

ModsStarbound install mods on server

Split screen setup

  1. Install and run Universal Split Screen: see the quick start guide

  2. In options, load the Starbound preset.

  3. Go back to the Current window tab. Alt+tab into the first instance. Set the mouse and keyboard. Repeat for the other instances.

  4. Click Start split screen. You should now be able to play. Press End to stop.

Default options

For reference, here are the default options.

  • 2Prerequisites
    • 2.2SteamCmd
  • 3Running And Downloading Server With SteamCMD
  • 4Advanced Usage
    • 4.2Terminal Multiplexers
  • 5Configuration

Introduction

Skyrim special edition mod list. This guide will help new server owners setup a Starbound server on a Linux server. This guide focuses on using Ubuntu Server 16.04 and Debian 9. It is assumed Ubuntu Server/Debian is already installed and updated. If this is your first linux experience, click here to access a guide from canonical to help you install the server distribution.

It is also assumed you have forwarded the appropriate ports to allow incoming outside connections if you are behind a NAT. Starbound uses port 21025 over TCP and UDP by default and requires a 64-bit operating system to run.

Prerequisites

This section will help you install the necessary dependencies before the server can run.

Libraries

The default Ubuntu and Debian installations do not provide all the necessary packages to run the game and SteamCMD. Install all the dependencies using the following command.

lib32gcc1 is a 32-bit library required by SteamCMD. libvorbisfile3 is required by the Starbound server.

SteamCmd

The Steam Console Client or SteamCMD[1] is a command-line version of the Steam client. Its primary use is to install and update various dedicated servers available on Steam using a command-line interface.

This section will help you install the SteamCMD application used to download the Starbound dedicated server.

Mods

Download and Install

Create a non-admin user to install/update/run the server application.

Switch to this new user.

Create a directory for the SteamCMD client and enter it.

Download the SteamCMD application.

Mods

Extract the archive.

[ Optional ]Verify files are available in the directory.

Running And Downloading Server With SteamCMD

Downloading The Dedicated Server

Run the SteamCMD client.

When you start the application, you will notice that your prompt switches to steam> instead of the traditional prompt. We will now login for the first time with our steam account and we will install the server files.

SECURITY NOTE: in the following, especially the update script, putting your password in spot of <password> might risk your Steam account security. It is recommended to leave it out, in which case you will be prompted for your password when you update.

Tip: The directory can be named anything and be put anywhere (e.g. ./starbound_server, /home/steam/starbound, etc.). Do not use ~/ to represent the home directory for the user, user the full path instead.

Updating The Server

When Starbound updates, we want to make sure the server is up to date so your players will be able to continue playing on it. This section will help you create a script you can run to keep the server updated.

Use vim to create the shell script.

Write the script that will run SteamCMD and update the server. Press i to enter insert mode.

Tip: Save and quit vim by pressing esc to leave insert mode and then using the vim command :wq.


Change the permissions of the script so it can be executed while at the same time unreadable by other users.

Run the script with the following command every time you want to update the Starbound server.

Running The Server

This section will help you on running the server once it has been downloaded and updated.

Change into the Starbound server directory for Linux.

Run the server.

Once the server starts, you should see something similar to the following output

Congratulations! You're now successfully running your server.

Tip: To shutdown your server, press ctrl + c.

Advanced Usage

This section provides advanced usage for server admins wishing to run their server while not having to be connected to the terminal. There are two main ways to accomplish this: using an init system, or using a terminal multiplexer.

systemd

systemd is an init system that is built into most linux systems including Ubuntu and Debian. It manages the services that start with the server. The Starbound server can be setup as a service for systemd to manage. To use systemd services, your server operating system must use systemd as its init system.[2]

Create a file in /etc/systemd/system/starbound-server.service or the corresponding systemd service location.

Open the file for editing.

In the following example, the server will run as the steam user created above.

Refresh systemd using the systemctl command.[3]

To start the server, use the start command.

You can verify that it is running with the status command.

The result should look like the following.

You can use the stop command to shutdown the server gracefully.

To start the server upon boot you can use the enable command.

To keep the server from starting on boot use the disable command.

Terminal Multiplexers

Multiplexers allow you to use multiple terminal sessions in a single session. Multiplexers will also allow you to start the Starbound server and disconnect the session without killing the server.

GNU Screen

GNU Screen[4] is a multiplexer which should be installed by default on most linux distributions.

If Screen is not installed you can install it with your package manager.

Run Screen

A new terminal session will open up. You can type commands exactly as before.

Enter server directory and run the server.

To disconnect from the screen session, press ctrl + ad. This detaches from the session but it will still be running in the background.

Next time you want to access that terminal session, simply use:

Starbound Install Mods On Server

This resumes the previous screen session.

Byobu

I will use byobu in a split screen environment. (Note that all commands are to be executed by your non-admin user)

Starbound
Byobu Split Screen

How To Make Mods For Starbound

  • If you use windows and access the server via SSH, you will need to set your ssh client to UTF-8 translation and Xterm R6 type of function keys/keypad
  • The first step is to tell byobu to start automatically on login for our non-admin user
  • You can now press ctrl + a which will ask you if you want to have ctrl + a used as if you use screen or emacs. This is due to the conflict between the two applications. In screen, ctrl + a is used to send commands to the application, while in emacs ctrl + a is used to go to the begining of the line. For this guide we will use the screen type
  • Once we are back in our shell inside byobu, it is time to split the screen by pressing ctrl + a then pressing
  • Now our screen is split in two panes horizontally. To switch between the two, we only need to press ctrl + a then press the Tab button.
  • On the top tab, navigate to the starbound server folder and start the starbound server
  • On the bottom tab, simply navigate to the steam folder. This tab will be used to update the server files. I have this setup as it is more convenient than switching directories all the time.

How To Download Starbound Mods

Voila, you now have a fully running starbound server. Note that I did not do any port forwarding as it is something you should learn before tackling installing a server appliance. To disconnect from your byobu session, you simply need to press F6

Configuration

Starbound How To Install Mods On Server 1.8

By editing the file starbound_server.config in the storage directory, players can adjust the settings for the server they are hosting. The file is in the JSON format. If there are syntax errors in the file when the server starts then the file will be renamed starbound_server.config.old and replaced with the default configuration file.

How To Install Mods On Starbound Server

The following values may be modified:

Server Configuration

KeyDescriptionExampleDefault Value
allowAdminCommandsAllows admin commands on the servertrue
allowAdminCommandsFromAnyoneAllows admin commands to be executed by anyone on the serverfalse
allowAnonymousConnectionsAllow connections from any account without authenticationtrue
allowAssetsMismatchAllows clients with mismatched assets to join the servertrue
anonymousConnectionsAreAdminClients not authenticated are adminsfalse
bannedIPsList of banned IP addresses[]
bannedUuidsList of banned unique user ids[]
checkAssetsDigestfalse
clearPlayerFilesWipes the server of all player filesfalse
clearUniverseFilesWipes the server of all world filesfalse
clientIPJoinablefalse
clientP2PJoinabletrue
crafting: filterHaveMaterialsfalse
gameServerBindThe IP address the server should bind to::
gameServerPortThe port the server should listen on21025
interactiveHighlighttrue
inventory:pickupToActionBarShould items picked up be sent straight to the hotbartrue
maxPlayersThe maximum amount of players allowed on the server8
maxTeamSizeThe maximum amount of players allowed in a party4
playerBackupFileCountThe number of backups for a player file3
queryServerBindThe IP the query server should bind to::
queryServerPortThe port the query server should listen on21025
rconServerBindThe IP the rcon server should bind to::
rconServerPasswordThe password used to authenticate when connecting to the rcon server'
rconServerPortThe port the rcon server should listen on21026
rconServerTimeoutThe amount of time to wait before timing out a command in milliseconds1000
runQueryServerRuns the query serverfalse
runRconServerRuns the rcon serverfalse
safeScriptstrue
scriptInstructionLimitThe maximum allowed instructions per script10000000
scriptInstructionMeasureInterval10000
scriptProfilingEnabledfalse
scriptRecursionLimitThe maximum allowed recursive calls in a script100
serverFidelity'automatic'
serverNameName of the server'
serverOverrideAssetsDigestnull
serverUserslist of users that may log into the server using{}
tutorialMessagesShow the tutorials messagestrue

References

  1. https://developer.valvesoftware.com/wiki/SteamCMD
  2. https://de.wikipedia.org/wiki/Systemd
  3. https://wiki.ubuntuusers.de/systemd/systemctl/
  4. http://www.gnu.org/software/screen/
Retrieved from 'https://starbounder.org/mediawiki/index.php?title=Guide:LinuxServerSetup&oldid=181936'