An open API service indexing awesome lists of open source software.

https://github.com/brahmlower/ansible-stationeers

A role for creating Stationeers servers
https://github.com/brahmlower/ansible-stationeers

Last synced: 6 months ago
JSON representation

A role for creating Stationeers servers

Awesome Lists containing this project

README

          

# Stationeers

[![Install from Ansible Galaxy](https://img.shields.io/badge/role-bplower.stationeers-blue.svg)](https://galaxy.ansible.com/bplower/stationeers/)

A role for creating [Stationeers](https://stationeers.com/) servers.

## Requirements

No requirements

## Role Variables

There are currently 3 (soon to be 4) groups of variables. All available
variables and their default values are listed here. Further details are below.

```
service_name: stationeers
service_user: stationeers
service_group: stationeers
service_description: Dedicated Stationeers server
service_restart_permitted: yes
accept_steamcmd_license: no
stationeers_default_servername: Stationeers
stationeers_default_gameport: 27500
stationeers_default_updateport: 27015
stationeers_default_password:
stationeers_default_mapname: BASE
stationeers_default_description: Stationeers
stationeers_default_maxplayers: 30
stationeers_default_rconpassword: stationeers
```

### Service Variables

- Variable: `service_name`

Default: `stationeers`

Comments:

The name of the service to create.

- Variable: `service_name`

Default: `stationeers`

Comments:

The user the service should be run as.

- Variable: `service_group`

Default: `stationeers`

Comments:

The group the service user should be a member of.

- Variable: `service_description`

Default: `Dedicated Stationeers server`

Comments:

A description about the Stationeers server to add to the service file.

### SteamCMD Variables

- Variable: `accept_steamcmd_license`

Default: `no`

Comments:

Accepts the SteamCMD license agreement. This role will fail unless you set
this value to `true` or `yes`.

### Stationeers Default.ini Variables

These settings are all applied to the default.ini file.

- Variable: `stationeers_default_servername`

Default: `Stationeers`

Comments:

The server name presented in-game

- Variable: `stationeers_default_gameport`

Default: `27500`

Comments:

The port to run the server on

- Variable: `stationeers_default_updateport`

Default: `27015`

Comments:

- Variable: `stationeers_default_password`

Default:

Comments:

- Variable: `stationeers_default_mapname`

Default: `BASE`

Comments:

The name of the map to load

- Variable: `stationeers_default_description`

Default: `Stationeers`

Comments:

The description of the server presented in-game

- Variable: `stationeers_default_maxplayers`

Default: `30`

Comments:

Maximum number of simultaneous players

- Variable: `stationeers_default_rconpassword`

Default: `stationeers`

Comments:

Password to accept for rcon management

## Example Playbooks
-----------------

The most simple working example of this role is:

```
---
- name: Create Stationeers server
hosts: localhost
roles:
- role: bplower.stationeers
accept_steamcmd_license: yes

```

SteamCMD requires accepting a license agreement during installation. I will not
presume to make potentially legally binding decisions on your behalf, so
acceptence of this license agreement is noted by the `accept_steamcmd_license`
variable. If you do not provide an affirmative value, you will see the following
error message:

```
TASK [bplower.stationeers : Check SteamCMD license agreement] ******************
fatal: [default]: FAILED! => {"changed": false, "failed": true, "msg": "You must accept the SteamCMD license by setting the variable 'accept_steamcmd_license: true'"}
```

You can set the rconn password via the default.ini settings:

```
---
- name: Create Stationeers server
hosts: localhost
roles:
- role: bplower.stationeers
accept_steamcmd_license: yes
stationeers_default_rconpassword: MySuperSecurePassword
```

## License

MIT