Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rexxars/windward-slack

Monitors a Windward server and notifies a slack channel when someone enters or exits the game
https://github.com/rexxars/windward-slack

Last synced: 11 days ago
JSON representation

Monitors a Windward server and notifies a slack channel when someone enters or exits the game

Awesome Lists containing this project

README

        

# windward-slack

Monitors a [Windward](http://store.steampowered.com/app/326410/) server and notifies a slack channel when someone enters or exits the game.

## Setup

```
git clone https://github.com/rexxars/windward-slack.git
cd windward-slack
npm install
npm start
```

## Docker

There is also a docker image available. Run `docker run rexxars/windward-slack`. Be sure to set the environment variables listed below.

## Environment variables

Note that these can also be set in a `.env` file in the app folder.

- `SLACK_WEBHOOK_URL` - Incoming webhook URL for your slack. Starts with `https://hooks.slack.com`
- `SLACK_CHANNEL` - Channel to post notifications to. Defaults to `#windward`
- `SLACK_USERNAME` - Username to use when posting notifications. Defaults to `Windward`
- `SLACK_ICON_URL` - Icon URL to use for the user that posts the notifications
- `WINDWARD_SERVER_URL` - Server URL. If your windward server is at `somehost.com:5127`, use `http://somehost.com:5127/`.

## License

MIT-licensed. See LICENSE.