Description

Rusty Watcher Getting Started

These instructions will get you a copy of the project up and running on your local machine. See ‘Installing’ for notes on how to deploy the project on a live system.

If you are having any issues, head over to the this github page and create an Issue. Furthermore all source code can be found there with the project files.

Images

Installing

A step by step series of examples that tell you how to get this programm running

1. Downloading:
Head over to the ‘Release’ tab and download the latest release.

2. Setting up the files:
Unzip the folder

3. Setting up the program:
Now run the RustyWatcher.exe

4. Setting up the bot:
Head over to the ‘Files’ folder and edit the ‘config.json’. After you set up all the options you can run the program and everything should be working!
If you plan to use the chatlog feature, be sure to also install the plugin on your server (more below).

5. Setting up your server (only needed for the chatlog feature!):
For this head over to uMod and install oxide. Then move the RustyWatcher.cs file into your ./oxide/plugins folder. In case you are using BetterChat also be sure to update to the one I include in this file as it adds an essential API method.

Discord Bot Token

If you don’t know what a discord bot token is, or how to retrieve it, then have a look at this guide.

Discord Webhook Url

Since on high populated servers the chat can get heated and therefore a lot of messages sent in a short period of time, I opted for using Webhooks instead of the usual message embeds as they can contain multiple embeds per message.
You can create a Webhook via right-clicking the channel you want to receive the chat messages in, then ‘Edit Channel’, next head over to ‘Integrations’ and click ‘Create Webhook’. There you will find the option ‘Copy Webhook Url’.

Steam API Key

To allow for the steam icons to show in the chatlog you need to provide a Steam API key. You can find/create your own Steam API Key here.

License

This project is licensed under the MIT License – see the here for details

Credits

• Captain John Silver for making the icon