7_Days_to_Die/README.md

# 7 Days To Die Game Server Linux Scripts
A set of opinionated scripts used to manage 7 days to die.

# Table of Contents
[TOC]

# Requirements
- Required
    - [tmux](https://github.com/tmux/tmux)
        - Used to run servers in detached sessions
    - [steamcmd](https://developer.valvesoftware.com/wiki/SteamCMD)
        - Used to install 7 days to die game servers
        - Important, this MUST be in your PATH variable.
        This script calls the [general](https://gitlab.orion-technologies.io/game-servers/general)
        installer script which configures steamcmd to be in `/usr/local/bin`.
        If this is not in your path, the deployed scripts will ***NOT*** work.

- Optional
    - [pv](https://github.com/icetee/pv)
        - Used to show progress for backup operations

# Automatic Installation
Must be ran as `root` or a user with access to `sudo su`

```bash
bash -c "$(curl https://gitlab.orion-technologies.io/game-servers/7-days-to-die/-/raw/Development/install.bash)"
```

# Defaults
By default all servers start at an offset of 50000 + server id. For instance, if you were to start `Server-1`,
the server id would be 1. As such the port `Server-1` would run on is 50001, `Server-2` would be 50002, and so on.

By default the base directory for all servers to be installed to is `~/7-Days-To-Die`.

# Usage
Switch to the `sdtd` user and source `.bash_profile` in order to use these scripts assuming automatic installation has
been used.

Basic usage:

- Starting a server
    ```bash
    7D2D-Manage start -s 1
    ```
    this would start `Server-1`.
- Stopping a server
    ```bash
    7D2D-Manage kill -s 1
    ```
    this would stop `Server-1`
- Updating a server
    ```bash
    7D2D-Manage update -s 1
    ```
    this would update `Server-1`
- Getting a backup archive of a server
    ```bash
    7D2D-Manage backup -s 1
    ```
    this would backup `Server-1`
- List installed and running servers
    ```bash
    7D2D-Manage list -r
    ```
    this would list running servers
    ```bash
    7D2D-Manage list -i
    ```
    this would list installed servers, note that this only checks if the server directory exists, not if any
    server files exist within the directory itself

To learn more usage, pass -h to any option, e.g to get base options:
```bash
7D2D-Manage -h
```
and to get, for instance, start options:
```bash
7D2D-Manage start -h
```

See the [wiki](https://gitlab.orion-technologies.io/game-servers/7-days-to-die/-/wikis/home) for details.