Skip to content

Commit c59b0da

Browse files
authored
Add instructions to run in README.md
1 parent 92c2698 commit c59b0da

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,53 @@ YAToDB is a simple and easy-to-use truth or dare Discord bot, developed in Pytho
1010
* **/truth**: Gives a truth based question.
1111
* **/dare**: Gives a dare based question.
1212
* **/suggest**: Suggest a new question for truth or dare game modes.
13+
14+
## How to run
15+
<ol>
16+
<li>
17+
Go to your bot folder in your file manager. Go to the <code>config</code> folder and open the <code>startup.json</code> file.
18+
19+
Now go ahead and insert your Discord bot token in the `token` part of the file. If you don't have one, go to <b>https://discord.com/developers</b> and make a new application.
20+
21+
![Screenshot_20230506_231226](https://user-images.githubusercontent.com/72265661/236639057-c4eace3d-d422-4e6e-b5d4-0e9190945521.png)
22+
23+
After pasting the token, copy your Discord user ID and paste it into the `owner_id` part of the file. Save the file to apply changes.
24+
</li>
25+
26+
<li>Open your terminal emulator (command prompt in Windows, terminal in Linux and MacOS). <b>Do not open as administrator as elevated permissions are not required.</b></li>
27+
<br>
28+
<li>Move to the directory in which the bot source is located. For example, if my bot folder is located in my Desktop folder, this should be run:
29+
30+
Windows:
31+
```bat
32+
cd C:\Users\{your username}\Desktop\YAToDB-main
33+
```
34+
35+
Linux/MacOS:
36+
```bash
37+
cd ~/Desktop/YAToDB-main
38+
```
39+
</li>
40+
<br>
41+
<li>Type in the following command to start the bot.
42+
43+
```bash
44+
python main.py
45+
```
46+
47+
If `poetry` is installed on your machine, the `py-cord` library will be automatically installed, along with all of its dependencies. If not, run these two commands:
48+
49+
```bash
50+
python -m pip install py-cord
51+
python main.py
52+
```
53+
</li>
54+
<br>
55+
<li>If you see this in your terminal emulator,
56+
57+
```
58+
[client] Bot client successfully signed into API. (startup time)
59+
```
60+
61+
That means you're all set!</li>
62+
</ol>

0 commit comments

Comments
 (0)