jjanzen/sily-bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Jacob Janzen 2024-12-30 21:29:42 -06:00
parent b0fcbe49b4
commit 3af314ef13
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -6,9 +6,8 @@ A bot that automates silliness.
1. Create a new bot at https://discord.com/developers/applications/ 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 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/ 3. Clone the latest version of `sily-bot` with `git clone https://git.jjanzen.ca/index.cgi/sily-bot.git`
4. Unzip the file and enter the `sily-bot-<version>` directory. 4. Populate your .env file:
5. Populate your .env file:
```ini ```ini
APP_ID=<APPLICATION ID> APP_ID=<APPLICATION ID>
DISCORD_TOKEN=<TOKEN> DISCORD_TOKEN=<TOKEN>
@ -20,9 +19,9 @@ A bot that automates silliness.
* DISCORD_TOKEN is found by reseting the token at https://discord.com/developers/applications/<id\>/bot * 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` * 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. * PORT is the port that the application should run on. This value is optional and defaults to 3000.
6. Install dependencies with `npm install` 5. Install dependencies with `npm install`
7. Register the bot commands with `npm run register` 6. Register the bot commands with `npm run register`
8. Run the bot with `npm run start` 7. Run the bot with `npm run start`
### Note on accessing the bot ### Note on accessing the bot