100 lines
2.7 KiB
Markdown
100 lines
2.7 KiB
Markdown
<!-- markdownlint-disable MD033 -->
|
|
|
|
# 1800queue
|
|
|
|
## Prerequirements
|
|
|
|
Download and install [Node.js](https://nodejs.org/en/)
|
|
|
|
<details>
|
|
<summary><b>Your bot's token</b></summary>
|
|
<br>
|
|
<p>Your bot's token can be found in your <a href="https://discord.com/developers/applications">Discord dev portal</a></p>
|
|
<ol>
|
|
<li>
|
|
Create or choose your application
|
|
</li>
|
|
<li>
|
|
Go to the <code>Bot</code> section
|
|
<ul>
|
|
<li>
|
|
click <code>Add Bot</code> if you haven't already
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
Copy your token
|
|
</li>
|
|
</ol>
|
|
</details>
|
|
|
|
## Automatic Installation/Updating
|
|
|
|
1. Download and extract this repository
|
|
2. Open the `scripts` folder
|
|
3. Open the folder that corresponds with your operating system
|
|
4. Run the `install` file
|
|
|
|
## Manual Installation/Updating
|
|
|
|
1. Download and extract this repository
|
|
2. Open the directory that contains `package.json` in your command prompt or terminal
|
|
3. Run the command `npm install`
|
|
4. Create a file called `token` in the same directory and enter your bot client's token
|
|
|
|
## Starting
|
|
|
|
**Important**: the bot's invite needs permission to `Create Commands` and `Send Messages`
|
|
|
|
1. Open the `scripts` folder
|
|
2. Open the folder that corresponds with your operating system
|
|
3. Run the `start` file
|
|
|
|
## Other Start Scripts
|
|
|
|
<details>
|
|
<summary><b>Mac/Linux Screen</b></summary>
|
|
<br>
|
|
<p>Screen allows the bot to run in the background without a terminal present</p>
|
|
<p><a href="https://linuxize.com/post/how-to-use-linux-screen/">Tutorial for usage</a>, check if it's installed already before installing</p>
|
|
<p><b>Installing</b></p>
|
|
<ul>
|
|
<li>
|
|
<p>Mac</p>
|
|
<ol>
|
|
<li>Install <a href="https://formulae.brew.sh/"><code>Homebrew</code></a></li>
|
|
<li>Open the terminal and run the command <code>brew install screen</code></li>
|
|
</ol>
|
|
</li>
|
|
<li>
|
|
<p>Linux</p>
|
|
<ul>
|
|
<li>Use your distribution's package manager to find <code>screen</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</details>
|
|
|
|
<details>
|
|
<summary><b>Mac/Linux Tmux</b></summary>
|
|
<br>
|
|
<p>Tmux allows the bot to run in the background without a terminal present</p>
|
|
<p><a href="https://linuxize.com/post/getting-started-with-tmux/">Tutorial for usage</a>, check if it's installed already before installing</p>
|
|
<p><b>Installing</b></p>
|
|
<ul>
|
|
<li>
|
|
<p>Mac</p>
|
|
<ol>
|
|
<li>Install <a href="https://formulae.brew.sh/"><code>Homebrew</code></a></li>
|
|
<li>Open the terminal and run the command <code>brew install tmux</code></li>
|
|
</ol>
|
|
</li>
|
|
<li>
|
|
<p>Linux</p>
|
|
<ul>
|
|
<li>Use your distribution's package manager to find <code>tmux</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</details>
|