You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# Gagbot
2
-
A bot for NSFW roleplay involving chat control on users! This is still under active development! The bot is written using Node.js and leverages the [Discord.js](https://discord.js.org/) library.
2
+
A bot for NSFW roleplay involving chat control on users! This is still under active development! The bot is written using Node.js and leverages the [Discord.js](https://discord.js.org/) library. See [Setup](https://github.com/Enraa/Gagbot/blob/main/SETUP.md) for setting this project up.
3
3
4
4
### What is it?
5
5
This bot is designed to facilitate roleplay scenarios involving certain toys within a channel. This is intended for use only with consenting adults and should not be considered or tolerated in environments with users below that age. The effects are also strictly limited to moderately tasteful text and holds no NSFW graphics. This bot's focus is on facilitating the environments in which others can engage in that, if they so choose.
-[Node.js](https://nodejs.org/en/download) Version 20.15.1 or greater
4
+
5
+
### Initial Setup (Local)
6
+
#### Step 1 - Get the Repo
7
+
- Clone the git repo - **git clone <span>https:</span>//github.com/Enraa/Gagbot**
8
+
- or [download the repo as a zip file](https://github.com/Enraa/Gagbot/archive/refs/heads/main.zip)
9
+
10
+
#### Step 2 - Get a Discord Developer Token
11
+
- Navigate to the [Discord Developer Portal](https://discord.com/developers/applications) and sign in with your Discord account.
12
+
- Create a New Application
13
+
- Under Bot, scroll down to **Privileged Gateway Intents** and enable **Server Members Intent** and **Message Content Intent**.
14
+
- Scroll back up to **Token** and click the **Reset Token** button. **Write down the token it provides.**
15
+
- Under **Installation**, uncheck **User Install** and scroll to **Guild Install** scopes and add **bot**. It should already have **applications.commands**.
16
+
- Navigate to the link provided under **Install Link**. This will join the bot to your server.
17
+
18
+
#### Step 3 - Set up the .env File
19
+
- Copy the **.env.md** file provided in the project's directory and name the copy **.env**
20
+
- Place the token noted above in the line under **DISCORDBOTTOKEN**.
21
+
22
+
#### Step 4 - Run the Bot
23
+
- Navigate to the root of the directory you placed the bot in
24
+
- Before running for the first time, install all of the node modules - **npm install**
25
+
- Run the bot - **node index**
26
+
27
+
### Initial Setup (Docker)
28
+
- Obtain a Discord Developer token and join the bot using the instructions under Step 2 above.
29
+
- The following Docker Compose script can be used to spin the bot up on a Docker instance:
30
+
```
31
+
version: "3.9"
32
+
33
+
services:
34
+
gagbot:
35
+
build: https://github.com/Enraa/Gagbot.git
36
+
image: gagbot
37
+
volumes:
38
+
- gagbotfilelocation:/mnt/GagbotFiles
39
+
container_name: gagbot
40
+
restart: unless-stopped
41
+
environment:
42
+
NODE_ENV: production
43
+
DISCORDBOTTOKEN: "MTQ----------------a"
44
+
GAGBOTFILEDIRECTORY: "/mnt/GagbotFiles"
45
+
BACKUPDELAY: "3300000"
46
+
SAVEDELAY: "120000"
47
+
```
48
+
This can be pasted into a new stack in Portainer or any other Docker container management. Note, you will want to ensure you set up a GAGBOTFILEDIRECTORY and point it appropriately to a storage the container has read/write access to. This will ensure the data persists across container restarts.
49
+
50
+
### Using the Bot
51
+
#### Step 1 - Setup a Channel
52
+
- In the server that the bot has been joined to, ensure that it either has role or channel specific permissions:
53
+
-**View Channel**
54
+
-**Manage Messages**
55
+
-**Manage Webhooks**
56
+
-**Manage Threads** (optional)
57
+
-**Send Messages in Threads** (optional)
58
+
#### Step 1a - Setup a Webhook (optional, but highly recommended!)
59
+
- While the bot can setup webhooks for you, the webhook will not be able to use external emoji. To get around this issue, you *must* create a Webhook inside the channel the bot will be running in and call it **Gagbot**. Once created, the bot should be able to pick it up and use it in the next step.
60
+
#### Step 2 - Configure the Bot for the Server
61
+
- Type **/config** to bring up the Bot's configuration menu. Server moderators (those with a role that has **Manage Messages**) can see the Server Settings menu. In there, click the button to setup an initial configuration. This will also deploy all of the other commands.
62
+
- Select the channel you want the bot to function in. It will save only if it has the required permissions above.
collarparts.push(`<:collar:1449984183261986939> Collar: **${currentcollartext}**\n-# ⤷ ${lockemoji} **Key held by <@${getCollar(inspectuser.id).keyholder}>**`);
258
+
collarparts.push(`${process.emojis.collar} Collar: **${currentcollartext}**\n-# ⤷ ${lockemoji} **Key held by <@${getCollar(inspectuser.id).keyholder}>**`);
0 commit comments