https://github.com/spiretf/dispenser

Automatically spawn and destroy a tf2 server on a schedule
https://github.com/spiretf/dispenser

Last synced: 1 day ago
JSON representation

Automatically spawn and destroy a tf2 server on a schedule

• Host: GitHub
• URL: https://github.com/spiretf/dispenser
• Owner: spiretf
• License: apache-2.0
• Created: 2021-03-28T18:02:12.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-14T18:56:45.000Z (5 months ago)
• Last Synced: 2024-08-02T13:22:07.839Z (3 months ago)
• Language: Rust
• Size: 166 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-tf2-devs - spiretf/dispenser - rust - Automatically spawn and destroy a tf2 servers in the cloud on a schedule (Table of contents / Hosting)

README

        
# Dispenser

Automatically spawn and destroy a tf2 server on a schedule

## Usage

- Copy `config.sample.toml` to `config.toml` and edit accordingly

- Start `dispenser config.toml` as a system service

When the configured start schedule is reached it will create a new cloud server, update the dyndns (optional)

and install a tf2 server.

This server is then destroyed when the stop schedule is reached.

As a failsafe against unexpected costs or destroying the wrong server, this program will not spawn any server

if it already detects a running one, and it will only destroy a server that was created by the program.

This does mean that if the program is (re-)started while a server is already active, the program will not

start and destroy any server because it can't be sure it should control the running server.

You'll need to manually destroy the existing server in that case.

You can overwrite this behavior by setting `manage_existing = true` in your `config.toml`,  

## Manual usage

Instead of managing the servers on a schedule with a background server you can also manually manage the server.

### List running servers

```shell

dispenser config.toml list

```

### Start a new server

```shell

dispenser config.toml start

```

Note that this will not start an additional server is a server is already running

### Stop a running server

```shell

dispenser config.toml stop

```

## Dealing with secrets

If you want to store your config file in version control but don't want to store your secrets there,

you can choose to load the secrets from other files by specifying the secret as an absolute path.

This can be done for the following config options:

  `server.demostf_key`, `server.logstf_key`, `vultr.api_key`, `digitalocean.api_key` and `dyndns.password`.

## TODO

- [x] don't blindly kill server if there are players connected

- [ ] kill the server earlier if everyone disconnected

- [x] digital ocean backend

- [ ] more backends?