Unitystation - User contributions [en]

Host a Server/en

2024-05-05T03:07:49Z

FuzzyBot: Updating to match new version of source page

<Languages />
So you want to host a Unitystation server? That's awesome! Let me guide you through the process step-by-step in this article. There are several options for hosting your server, so make sure to jump to the section that best fits your situation.'''[[Category:Technical Guides]]'''

== Appearing in the Server List ==
Currently, Unitystation staff manually curates the server list to ensure that all servers listed are safe for players. While we are working on enabling anyone to appear on the server list in the future, we must ensure that any risks associated with that openness are mitigated to prevent possible malicious attacks that may affect our players. If you would like to be whitelisted, please contact us on our Discord server.

== I Just Want to Play With Friends ==
Good news, it's pretty easy to set up! The Unitystation client doubles as a server, so you can host and play using a single instance of the game on your own computer.

To do this, you'll need to make sure you've opened '''7777''' port on your router to allow incoming connections. The specific steps to achieve this depend on your router brand, among other factors, so you'll need to do some googling. Try searching for "Portforwarding [YOUR ROUTER BRAND]" to get started.

After the port forwarding is done, just follow these steps:

====== Run [[StationHub Launcher]] ======
[[File:Host server 1 1.png|center]]

====== Go to Installations tab ======
From here you can run any version of the game you have downloaded without joining a server. If your installations tab is empty, try joining a server first to get their version of the game or manually find the version you want from our CDN following this pattern: '''<nowiki>https://unitystationfile.b-cdn.net/UnityStationDevelop/{PLATFORM}/{VERSION</nowiki> NUMBER}.zip''' where {'''PLATFORM'''} can be one of "'''linuxserver'''", "'''StandaloneLinux64'''", "'''StandaloneOSX'''" or "'''StandaloneWindows64'''". We apologize for any inconvenience caused by the current distribution method, but we plan to improve it for servers in the future.

Click on '''Launch''' on the selected version of the game.
[[File:Host server 1 2.png|center|asdsd]]

====== Once inside the game ======
Simply click on '''HOST''' and that's it! Yeah, really! Now you just need to give your friends your '''public IP''' and make them launch the game following steps I to II but choose '''JOIN''' instead in the third step and fill in the given '''public IP''' and the 7777 port.
[[File:Host server 1 3.png|center]]

== I Want to Host a Dedicated Server ==
Hosting a dedicated server is also straightforward. Technically, you can just use whatever version you downloaded and run it with the '''--nographics''' argument. However, the preferred method, and the one we'll be discussing in this article, is using '''Docker'''.

[https://www.docker.com/ Docker] is a platform for running applications in containers, which makes it easy to manage and deploy your server. We will be also including an optional step in this guide to have a web graphical interface so you can manage your server with even more ease!

====== Download and Install Docker ======
You can get Docker from its [https://docs.docker.com/engine/install/ official website]. The [https://docs.docker.com/engine/install/ubuntu/ Ubuntu installation guide] is pretty good as well, so you can use that if it is your server distribution or use it as a starter.

====== Use a Docker Compose file ======
These configuration files make it easy to download, run, and publish any application distributed as a Docker image. To get started create a '''docker-compose.yml''' file somewhere in your server. Use the following simple example as a guide for yours:<syntaxhighlight lang="yaml" line="1" start="1">
version: "3.7"

services:
unitystation:
image: unitystation/unitystation:stable
ports:
- 7777:7777/udp
- 7777:7777/tcp
- 7778:7778/tcp
environment:
SERVER_NAME: Unitystation - EU02 Staging
HUB_USERNAME: YOUR_USERNAME
HUB_PASSWORD: YOUR_PASSWORD
labels:
- io.portainer.accesscontrol.public
volumes:
- /root/staging/admin:/server/Unitystation_Data/StreamingAssets/admin
</syntaxhighlight>Don't let it intimidate you, we will explain now what matters the most in there.

'''image''' key determines what version of the game will be used. You can replace '''stable''' with a build number if you want to use a specific version or leave it as '''stable''' to be on the latest available version. If you want to be on the absolute latest version, on par with our [[Staging Servers]], you can use '''develop''' instead. Find all the versions we have published so far on our [https://hub.docker.com/repository/docker/unitystation/unitystation/general Docker Hub page]

if you do have hub credentials provided by [[User:Gilles|Gilles]] over Discord ([[Host a Server#Appearing in the Server List|see above to read about it]]), you can set the following environmental variables in your docker-.compose file:

'''SERVER_NAME''' is how your server will be displayed in the server list.

'''HUB_USERNAME''' you provided while interviewed to be whitelisted on Discord.

'''HUB_PASSWORD''' is the token you got back in the same interview.

'''labels''' key is to give Portainer control over this container. Learn about Portainer in the next optional step.

'''volumes''' mounts folders and files in your filesystem to the container. This will allow the containerised game to store persistent information, such as config files, admins, whitelist, bans, etc.There are many files you might be interested in mounting and we will expand on them later on this guide.

====== Running the server ======
From the same folder as your '''docker-compose.yml''' file, run the following command:<syntaxhighlight lang="shell">
docker compose up -d
</syntaxhighlight>This command will download everything you need, run and publish the server! You will be able to join it as soon as the server is done loading.

If you want to stop the server, you can use<syntaxhighlight>
docker compose down
</syntaxhighlight>Pretty simple, isn't it?

====== Installing Portainer ======
Portainer is another container that will host a web interface to manage your containers. From here you can easily start, stop, update your Unitystation servers just by clicking buttons.

To install Portainer, read their [https://docs.portainer.io/start/install-ce/server/docker/linux official guide]. By the end, you will have a graphical interface that looks like this:
[[File:Host a server 1 4.png|center]]
Pretty convenient, isn't it?

====== Further managing your server ======
At this point, you should have a running server and be able to join it. If you experience any issue, don't hesitate to ask on our discord help or developer channel.

Now you possibly want to further manage your server, change config files, add admins, etc. Please refer to [[Manage Your Server|the following page to read more about it]].

Translations:Host a Server/27/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

Now you possibly want to further manage your server, change config files, add admins, etc. Please refer to [[Manage Your Server|the following page to read more about it]].

Translations:Host a Server/26/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Further managing your server ======
At this point, you should have a running server and be able to join it. If you experience any issue, don't hesitate to ask on our discord help or developer channel.

Translations:Host a Server/25/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

To install Portainer, read their [https://docs.portainer.io/start/install-ce/server/docker/linux official guide]. By the end, you will have a graphical interface that looks like this:
[[File:Host a server 1 4.png|center]]
Pretty convenient, isn't it?

Translations:Host a Server/24/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Installing Portainer ======
Portainer is another container that will host a web interface to manage your containers. From here you can easily start, stop, update your Unitystation servers just by clicking buttons.

Translations:Host a Server/23/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

If you want to stop the server, you can use<syntaxhighlight>
docker compose down
</syntaxhighlight>Pretty simple, isn't it?

Translations:Host a Server/22/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Running the server ======
From the same folder as your '''docker-compose.yml''' file, run the following command:<syntaxhighlight lang="shell">
docker compose up -d
</syntaxhighlight>This command will download everything you need, run and publish the server! You will be able to join it as soon as the server is done loading.

Translations:Host a Server/21/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

'''volumes''' mounts folders and files in your filesystem to the container. This will allow the containerised game to store persistent information, such as config files, admins, whitelist, bans, etc.There are many files you might be interested in mounting and we will expand on them later on this guide.

Translations:Host a Server/20/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

'''labels''' key is to give Portainer control over this container. Learn about Portainer in the next optional step.

Translations:Host a Server/19/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

'''HUB_PASSWORD''' is the token you got back in the same interview.

Translations:Host a Server/18/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

'''HUB_USERNAME''' you provided while interviewed to be whitelisted on Discord.

Translations:Host a Server/17/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

'''SERVER_NAME''' is how your server will be displayed in the server list.

Translations:Host a Server/16/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

if you do have hub credentials provided by [[User:Gilles|Gilles]] over Discord ([[Host a Server#Appearing in the Server List|see above to read about it]]), you can set the following environmental variables in your docker-.compose file:

Translations:Host a Server/15/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

'''image''' key determines what version of the game will be used. You can replace '''stable''' with a build number if you want to use a specific version or leave it as '''stable''' to be on the latest available version. If you want to be on the absolute latest version, on par with our [[Staging Servers]], you can use '''develop''' instead. Find all the versions we have published so far on our [https://hub.docker.com/repository/docker/unitystation/unitystation/general Docker Hub page]

Translations:Host a Server/14/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

services:
unitystation:
image: unitystation/unitystation:stable
ports:
- 7777:7777/udp
- 7777:7777/tcp
- 7778:7778/tcp
environment:
SERVER_NAME: Unitystation - EU02 Staging
HUB_USERNAME: YOUR_USERNAME
HUB_PASSWORD: YOUR_PASSWORD
labels:
- io.portainer.accesscontrol.public
volumes:
- /root/staging/admin:/server/Unitystation_Data/StreamingAssets/admin
</syntaxhighlight>Don't let it intimidate you, we will explain now what matters the most in there.

Translations:Host a Server/13/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Use a Docker Compose file ======
These configuration files make it easy to download, run, and publish any application distributed as a Docker image. To get started create a '''docker-compose.yml''' file somewhere in your server. Use the following simple example as a guide for yours:<syntaxhighlight lang="yaml" line="1" start="1">
version: "3.7"

Translations:Host a Server/12/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Download and Install Docker ======
You can get Docker from its [https://docs.docker.com/engine/install/ official website]. The [https://docs.docker.com/engine/install/ubuntu/ Ubuntu installation guide] is pretty good as well, so you can use that if it is your server distribution or use it as a starter.

Translations:Host a Server/11/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

[https://www.docker.com/ Docker] is a platform for running applications in containers, which makes it easy to manage and deploy your server. We will be also including an optional step in this guide to have a web graphical interface so you can manage your server with even more ease!

Translations:Host a Server/10/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

== I Want to Host a Dedicated Server ==
Hosting a dedicated server is also straightforward. Technically, you can just use whatever version you downloaded and run it with the '''--nographics''' argument. However, the preferred method, and the one we'll be discussing in this article, is using '''Docker'''.

Translations:Host a Server/9/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Once inside the game ======
Simply click on '''HOST''' and that's it! Yeah, really! Now you just need to give your friends your '''public IP''' and make them launch the game following steps I to II but choose '''JOIN''' instead in the third step and fill in the given '''public IP''' and the 7777 port.
[[File:Host server 1 3.png|center]]

Translations:Host a Server/8/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

Click on '''Launch''' on the selected version of the game.
[[File:Host server 1 2.png|center|asdsd]]

Translations:Host a Server/7/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Go to Installations tab ======
From here you can run any version of the game you have downloaded without joining a server. If your installations tab is empty, try joining a server first to get their version of the game or manually find the version you want from our CDN following this pattern: '''<nowiki>https://unitystationfile.b-cdn.net/UnityStationDevelop/{PLATFORM}/{VERSION</nowiki> NUMBER}.zip''' where {'''PLATFORM'''} can be one of "'''linuxserver'''", "'''StandaloneLinux64'''", "'''StandaloneOSX'''" or "'''StandaloneWindows64'''". We apologize for any inconvenience caused by the current distribution method, but we plan to improve it for servers in the future.

Translations:Host a Server/6/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

====== Run [[StationHub Launcher]] ======
[[File:Host server 1 1.png|center]]

Translations:Host a Server/5/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

After the port forwarding is done, just follow these steps:

Translations:Host a Server/4/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

To do this, you'll need to make sure you've opened '''7777''' port on your router to allow incoming connections. The specific steps to achieve this depend on your router brand, among other factors, so you'll need to do some googling. Try searching for "Portforwarding [YOUR ROUTER BRAND]" to get started.

Translations:Host a Server/3/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

== I Just Want to Play With Friends ==
Good news, it's pretty easy to set up! The Unitystation client doubles as a server, so you can host and play using a single instance of the game on your own computer.

Translations:Host a Server/2/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

== Appearing in the Server List ==
Currently, Unitystation staff manually curates the server list to ensure that all servers listed are safe for players. While we are working on enabling anyone to appear on the server list in the future, we must ensure that any risks associated with that openness are mitigated to prevent possible malicious attacks that may affect our players. If you would like to be whitelisted, please contact us on our Discord server.

Translations:Host a Server/1/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

So you want to host a Unitystation server? That's awesome! Let me guide you through the process step-by-step in this article. There are several options for hosting your server, so make sure to jump to the section that best fits your situation.'''[[Category:Technical Guides]]'''

Translations:Host a Server/Page display title/en

2024-05-05T03:07:47Z

FuzzyBot: Importing a new version from external source

Host a Server

Category:Jobs/en

2024-05-05T03:02:56Z

FuzzyBot: Updating to match new version of source page

<Languages/>
== '''What is a Job?''' ==
Jobs in Unitystation are what decide what your civilian duty is per round. There are currently 33 Jobs available in Unitystation, every job has clear and defined goals attached to them. Your job can be selected in two different ways, by selecting the demand for each job you want in character creation or by selecting a job after the round starts. The job you select determines your starting equipment, what areas you have access to, and what is expected of you by others throughout the round.
== '''Jobs by Department''' ==
{{Roles Footer}}
=== NOTE: Only Command through Service are listed above are available at round start. The rest are special cases. ===
__NOTOC__
__NOGALLERY__
[[Category:Roles]]

Category:Jobs/en

2024-05-05T03:02:40Z

FuzzyBot: Updating to match new version of source page

== '''What is a Job?''' ==
Jobs in Unitystation are what decide what your civilian duty is per round. There are currently 33 Jobs available in Unitystation, every job has clear and defined goals attached to them. Your job can be selected in two different ways, by selecting the demand for each job you want in character creation or by selecting a job after the round starts. The job you select determines your starting equipment, what areas you have access to, and what is expected of you by others throughout the round.
== '''Jobs by Department''' ==
{{Roles Footer}}
=== NOTE: Only Command through Service are listed above are available at round start. The rest are special cases. ===
__NOTOC__
__NOGALLERY__
[[Category:Roles]]

Translations:Category:Jobs/3/en

2024-05-05T03:02:38Z

FuzzyBot: Importing a new version from external source

=== NOTE: Only Command through Service are listed above are available at round start. The rest are special cases. ===

Translations:Category:Jobs/2/en

2024-05-05T03:02:37Z

FuzzyBot: Importing a new version from external source

== '''Jobs by Department''' ==

Translations:Category:Jobs/1/en

2024-05-05T03:02:37Z

FuzzyBot: Importing a new version from external source

Translations:Category:Jobs/Page display title/en

2024-05-05T03:02:37Z

FuzzyBot: Importing a new version from external source

Category:Jobs

Not Dying/en

2024-05-05T03:01:28Z

FuzzyBot: Updating to match new version of source page

{{Revision Request|reason=This is a direct import from the markdown wiki and such, formatting is very unappealing.}}
<Languages />

===Back to Basics===

Unitystation, like it's predecessor Space Station 13, has an incredibly steep learning curve. Death early on will force you into a ghost state where you watch over the round until someone clones you (there is a way to keep playing after death currently under implementation). But unlike Space Station 13, you can't respawn in anyway. If you are new to Unitystation here is a small list for you so you can try to not die instantly.

===How not to die instantly===

1) To not die you need to know the controls - W A S D for walking and mouse for interacting. You have two hands to pickup things with, you can swap between them with the X key. Using actual hands to move stuff arround can be confusing at first, but with some practice it gets done. See intents to find out how to interact with things and beings.

1a) Other controls: Q to drop the thing you are currently holding on the ground, Z to "activate" the item you are holding (it can also be done by clicking the item), R to throw the item you are holding far away, Ctrl + Click to drag something (a body or locker usually), and Shift + Click to see a description on something or someone.

1b) Talk controls: T to talk normally, Y to radio chat

2) Eat. Food can be found at the cafeteria, if food cannot be found then find a knife, hunt some prey (animals and humans work, but unless you want to get arrested use animals) and butcher it, the meat can then be used for a variety of foods.

3) If the door you try to open flashed yellow you probably should not go through it, because it's depressurized on the other side.

4) If you do need to walk through that door then get a heavy duty suit and preferably mag boots, and an oxygen supply, that requires a mask and an oxygen tank in your hot bar, to enable the supply click the icon on the right.

5) Do the "tutorial". The "tutorial" step of every round is opening your backpack, getting out the box in your backpack, putting on the oxygen mask from the box to your face slot, getting the oxygen bottle out, putting it on your pocket and enabling the oxygen supply.

6) Learn to do your role, to do so look on the bottom of the main page, it contains a guide on (almost) every role in the game.

7) Don't do crimes, unless you want to be brigged, and possibility abused, learn the Space Law if you want to, it is your best weapon against shitcurity.

8) If you get spaced (the act of being thrown out into space by pressure) shoot something or throw anything and everything you can in the direction you're flying, that will hopefully, make you fly the other way. Unless you have a spacesuit, you're still going to die, but you're more likely to be found by your crew mates. Also an extinguisher works for this, remember the wall-e movie?

9) If there is a Xenomorph invasion, Syndies, or too much chaos on board:

9a) If you are armed and robust, you can go at em (not recomended for newbies, but who cares), however, be careful and try to never go on your own.

9b) If you are not armed or not robust then run away, cower behind sec and hide in a locker, or get to the escape shuttle or some other safe place. You can also call atention to the thing that you saw through the radio (open the chat and click the radio icon)

10) Learn to build in case you need to, and more importantly to destroy (same guide) if you are trapped.

11) You should try to keep a tool-stacked tool-belt, med-kit, a light and some food at all times in your person. I prefer six cutlets, but to each their own.

12) You are expected to know how to role play to a certain extent, use these role play abbreviations. To roleplay means that you can ask for help in game as your character instead of using the mentor help button.

13) Try not to pick antagonists (antags) the first times you play, at least until you are familiar with the controls. If you want to start being antag, try being a traitor, and remember that as one you are allowed to get away with many war crimes, but try to only make life hell for your target, please.

14) Do not pick any security role untill you have at least some idea of how the combat system works (you are "robust" enough). If you're a security officer, please don't make power plays, it ruins the other's experience and gives you temporary euphoria, with regret afterwards.

15) If you're injured you should go to medical to get treated or treat yourself. You can see how bad you are doing by checking the color of your body in the ui.

16) If the floor is wet, press C to walk. You will move more slowly, but you wont slip and fall into the floor. You wont slip at all if you are wearing the janitors boots however.

17) And most importantly, talk. UnityStation is, in fact, a chating game, so experiment with the chat as much as you can before trying anything else.

(Being 'robust' is being acquainted with the combat system enough, a guide on which can be found here. How much is enough you ask? Well there's no real measure.)
[[Category:Needs Revision]]
[[Category:Beginner Guides]]

Translations:Not Dying/25/en

2024-05-05T03:01:26Z

FuzzyBot: Importing a new version from external source

(Being 'robust' is being acquainted with the combat system enough, a guide on which can be found here. How much is enough you ask? Well there's no real measure.)

Translations:Not Dying/24/en

2024-05-05T03:01:26Z

FuzzyBot: Importing a new version from external source

17) And most importantly, talk. UnityStation is, in fact, a chating game, so experiment with the chat as much as you can before trying anything else.

Translations:Not Dying/23/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

16) If the floor is wet, press C to walk. You will move more slowly, but you wont slip and fall into the floor. You wont slip at all if you are wearing the janitors boots however.

Translations:Not Dying/22/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

15) If you're injured you should go to medical to get treated or treat yourself. You can see how bad you are doing by checking the color of your body in the ui.

Translations:Not Dying/21/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

14) Do not pick any security role untill you have at least some idea of how the combat system works (you are "robust" enough). If you're a security officer, please don't make power plays, it ruins the other's experience and gives you temporary euphoria, with regret afterwards.

Translations:Not Dying/20/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

13) Try not to pick antagonists (antags) the first times you play, at least until you are familiar with the controls. If you want to start being antag, try being a traitor, and remember that as one you are allowed to get away with many war crimes, but try to only make life hell for your target, please.

Translations:Not Dying/19/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

12) You are expected to know how to role play to a certain extent, use these role play abbreviations. To roleplay means that you can ask for help in game as your character instead of using the mentor help button.

Translations:Not Dying/18/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

11) You should try to keep a tool-stacked tool-belt, med-kit, a light and some food at all times in your person. I prefer six cutlets, but to each their own.

Translations:Not Dying/17/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

10) Learn to build in case you need to, and more importantly to destroy (same guide) if you are trapped.

Translations:Not Dying/16/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

9b) If you are not armed or not robust then run away, cower behind sec and hide in a locker, or get to the escape shuttle or some other safe place. You can also call atention to the thing that you saw through the radio (open the chat and click the radio icon)

Translations:Not Dying/15/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

9a) If you are armed and robust, you can go at em (not recomended for newbies, but who cares), however, be careful and try to never go on your own.

Translations:Not Dying/14/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

9) If there is a Xenomorph invasion, Syndies, or too much chaos on board:

Translations:Not Dying/13/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

8) If you get spaced (the act of being thrown out into space by pressure) shoot something or throw anything and everything you can in the direction you're flying, that will hopefully, make you fly the other way. Unless you have a spacesuit, you're still going to die, but you're more likely to be found by your crew mates. Also an extinguisher works for this, remember the wall-e movie?

Translations:Not Dying/12/en

2024-05-05T03:01:25Z

FuzzyBot: Importing a new version from external source

7) Don't do crimes, unless you want to be brigged, and possibility abused, learn the Space Law if you want to, it is your best weapon against shitcurity.