diff options
| author | jacob janzen <53062115+JacobJanzen@users.noreply.github.com> | 2024-12-11 19:47:11 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-12-11 19:47:11 -0600 |
| commit | 7391eefb59ba4ea8d72c09a8dd577678c7e78aa8 (patch) | |
| tree | 6e250381647ed4915d75752ebe253c6d92c7e20c /README.md | |
| parent | 6007a8bbfac47cfe9318541eede484c890489c6e (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 47 |
1 files changed, 46 insertions, 1 deletions
@@ -1,3 +1,48 @@ # Sily Bot -A Discord bot that does things with very mediocre coding standards. +A bot that automates silliness. + +## How to run + +1. Create a new bot at https://discord.com/developers/applications/ +2. Set your Interactions Endpoint URL here: https://discord.com/developers/applications/<id\>/information +3. Download the latest version of `sily-bot` from here: https://github.com/JacobJanzen/sily-bot/releases/ +4. Unzip the file and enter the `sily-bot-<version>` directory. +5. Populate your .env file: + ```ini + APP_ID=<APPLICATION ID> + DISCORD_TOKEN=<TOKEN> + PUBLIC_KEY=<PUBLIC KEY> + TIMEZONE=<TIMEZONE> + PORT=<PORT> # optional + ``` + * APP_ID and PUBLIC_KEY are found at https://discord.com/developers/applications/<id\>/information + * DISCORD_TOKEN is found by reseting the token at https://discord.com/developers/applications/<id\>/bot + * TIMEZONE is base on the [IANA time zone database](https://www.iana.org/time-zones) e.g. `America/Winnipeg` + * PORT is the port that the application should run on. This value is optional and defaults to 3000. +6. Install dependencies with `npm install` +7. Register the bot commands with `npm run register` +8. Run the bot with `npm run start` + +### Note on accessing the bot + +This bot requires that there be a publicly accessible interactions endpoint URL. You're on your own for this as the setup entirely depends on your system. I run an Apache webserver that proxies requests for `/sily-bot` to `http://127.0.0.1:3000/` with the following: +```xml +<VirtualHost *:443> +# ... + SSLProxyEngine on + + <Location /sily-bot> + ProxyPass http://127.0.0.1:3000/ + ProxyPassReverse http://127.0.0.1:3000/ + </Location> +</VirtualHost> +``` + +## Current Abilities + +|Command|Description| +|---|---| +|`/pet`|You can pet sily-bot.| +|`/schedule-message <message> <cron>`|Schedule a message to be send later. Works like Linux cron jobs in the format `second minute hour day month weekday`. Put the number (or name of month or weekday) in each spot. If you want it to run every second, minute, etc. instead of once when it reaches the provided number, use a `*` instead of a number. For instance, to run a job every minute on January 4th, you might use `0 * * 4 January *`. The bot replies with a UUID that can be used to cancel the cron job later.| +|`/unschedule-message <id>`|Stop sending a message with the given id.| |