Skip to content

Commit cd01e25

Browse files
authored
Update README.md
1 parent 217adb3 commit cd01e25

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,22 @@
1010
- Clone the repo
1111
- Run `npm install`
1212
- Create a test server in Discord, if you don't already have one. This is where you'll eventually install your local bot to and can test commands in.
13-
14-
### Setting up .env
1513
- Duplicate the **example.env** file and rename it to just ".env"
1614

1715
### Create a test discord bot app
1816
- Sign into the [Discord Dev Portal](https://discord.com/developers/applications)
1917
- Create a new Application, call it whatever you like (eg "TestCrowbarBot")
18+
<img width="500" alt="Screenshot 2024-12-08 at 11 09 04 AM" src="https://github.com/user-attachments/assets/8dc2bc72-beec-4629-8378-330a12f03bb4">
19+
2020
- Add the app to your server
2121
- In the settings area of the newly created app, go to the "Installation" tab.
2222
- Uncheck "User Install" under **Installation Contexts**
2323
- Under **Default Install Settings**, add the "bot" scope and add the "Administrator" permission
2424
- Copy the **Install Link** and paste it in a browser
2525
- This should open up Discord with a prompt to install your application in a server.
2626
- Select your test server, click Continue, and then click Authorize (don't uncheck any permissions)
27+
<img width="500" alt="Screenshot 2024-12-08 at 11 20 18 AM" src="https://github.com/user-attachments/assets/7e7e9921-d151-4915-8d3e-d9575e25c01e">
28+
2729
- Update discord .env vars
2830
- Bot App Id
2931
- In the settings area of the newly created app, go to the "General Information" tab
@@ -34,8 +36,10 @@
3436
- Discord Server (Guild) ID
3537
- Open up Discord, right click the icon for your test server and select "Copy Server ID", paste it in your .env for `DISCORD_GUILD_ID`
3638
- If you don't see the copy option, you probably need to enable Developer Mode in Discord (Settings > Advanced > Developer Mode)
39+
<img width="206" alt="Screenshot 2024-12-08 at 11 48 08 AM" src="https://github.com/user-attachments/assets/516404de-24bf-4153-9be6-b3810a829d2c">
3740
- All other env vars can be left empty unless you need to test those specific features (eg github issue creation, sent to questions/issues commands, etc)
3841

3942
### Run the bot
4043
- `npm run dev`
4144
- You should now see the bot show as "online" in your test server and slash commands should now be available to run
45+
<img width="500" alt="Screenshot 2024-12-08 at 11 56 09 AM" src="https://github.com/user-attachments/assets/d4b33c4f-8df4-4864-8d80-4839f46ae399">

0 commit comments

Comments
 (0)