Contents

# QwtfDiscordBot

A Discord bot for checking the status of QuakeWorld Team Fortress servers


## Dependencies

  - Ruby >= 2.5.0
  - [qstat](https://github.com/multiplay/qstat) version with JSON support.  Tested with commit [2ab78bd5c30fbd47b2bdd4a6279296d66424b37e](https://github.com/multiplay/qstat/tree/2ab78bd5c30fbd47b2bdd4a6279296d66424b37e). Should be added to `$PATH`.


## Installation

    $ gem install qwtf_discord_bot


## Usage

Create a bot on discord.

Edit the `.env.example` file, update with your bot's `client_id` and `token` and save as `.env`.

    $ source .env


### List commands

    $ bundle exec exe/qwtf-discord-bot server help

There are two features:


### Server

This responds to `!server` messages by providing information about your game
server.

![screenshot of bot responding to !server command](server_screenshot.png)

```
Usage:
  qwtf_discord_bot server

Options:
  [--hostname=HOSTNAME]
                         # Default: localhost
  [--port=N]
                         # Default: 27500
```

E.G.

    $ bundle exec exe/qwtf-discord-bot server --hostname fortressone.ga --port 27501


### Watcher

This watches the game server and announces if anyone has joined the server. It
polls the server once every 30 seconds and will only report a player joining if
they haven't been connected for more than ten minutes.

![screenshot of bot reporting player joining server](watcher_screenshot.png)

```
Usage:
  qwtf_discord_bot watcher

Options:
  [--hostname=HOSTNAME]
                         # Default: localhost
  [--port=N]
                         # Default: 27500
```

E.G.

    $ bundle exec exe/qwtf-discord-bot watcher --hostname fortressone.ga --port 27501


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
qwtf_discord_bot-0.5.9	README.md
qwtf_discord_bot-0.5.8	README.md
qwtf_discord_bot-0.5.7	README.md
qwtf_discord_bot-0.5.6	README.md
qwtf_discord_bot-0.5.5	README.md
qwtf_discord_bot-0.5.4	README.md
qwtf_discord_bot-0.5.3	README.md
qwtf_discord_bot-0.5.2	README.md
qwtf_discord_bot-0.5.1	README.md
qwtf_discord_bot-0.5.0	README.md
qwtf_discord_bot-0.4.1	README.md