74 lines
1.8 KiB
Markdown
74 lines
1.8 KiB
Markdown
<!-- markdownlint-disable MD033 -->
|
|
|
|
# 1800queue
|
|
|
|
## Prerequirements
|
|
|
|
Download and install [Node.js](https://nodejs.org/en/)
|
|
|
|
## Automatic Installation
|
|
|
|
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
|
|
|
|
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
|
|
|
|
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>Mac/Linux Screen</summary>
|
|
<br>
|
|
<p>Screen allows the bot to run in the background without a terminal present</p>
|
|
<p>Installing</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>Mac/Linux Tmux</summary>
|
|
<br>
|
|
<p>Tmux allows the bot to run in the background without a terminal present</p>
|
|
<p>Installing</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>
|