Installing mods for StarBound

From 4netplayers Support Wiki
Jump to: navigation, search
Rent a StarBound server
Rent your own StarBound server now at 4Netplayers.com

In this article we describe how you can install mods on your StarBound server.
Tip: We recommend using an FTP program such as Filezilla.

Subscribe to mods

  1. First you have to subscribe to the mods you want to use in Steam.
    Open the page for the mod and click on Subscribe.
  2. Once you have subscribed to the mods you want, you must start your game at least once.
    This is necessary so that the mods are downloaded.
  3. Open the following directory on your computer:
    ../Steam/steamapps/workshop/content/211820/
    You will find this directory on the same hard drive where you installed the game.
  4. You should now see many numbered folders. These folders contain your mods.
    The name of the folder is the WorkshopID of the mod.
  5. Open the first folder, this should contain the following file: contents.pak.
    Rename the file e.g. to WorkshopID.pak or Modname.pak.
    Important: Choose a name that is easy for you to identify.
  6. Copy the file you just renamed into a separate directory.
  7. Now open the next workshop folder and rename the contents.pak.
  8. Repeat steps 6 & 7 until every contents.pak has been renamed and copied out.
  9. Now copy all mods into the game directory:
    ../steam/steamapps/common/Starbound/mods
    .


Important: Each player must have the same mods installed that are used on the server.
. Otherwise players will not be able to join the server.
Tip: Pack your mods and upload them to DropBox for example. If you give this DropBox link to your friends, they only have to unpack the mods and copy them into the mods folder.

Upload mods

  1. Stop your server. The status of your server must be Server not running!
  2. Connect to the Upload FTP with your FTP program.
    You can find the login data in the FTP overview by clicking on FTP.
  3. Upload your mods to the following directory:
    ConfigID/mods
    Note: The ConfigID or ConfigurationID for your server can be found on our page under Gameserver.
    If your ConfigID was e.g. 123456, the path would look like this:/123456/mods.
  4. When all mods have been uploaded, start your server.