WordleBot for Discord

A Discord bot that implements various Wordle related features.

Current Features

/playwordle: Simulate playing today's Wordle, or a given word
/wordleword: Tell the user today's Wordle answer, or the answer for a given date
/question: Answers a user's question about the bot
/wordlegpt: Replies to the user's input as an AI
/serverstatus: Gives basic info for the minecraft server at a given IP
/music: Plays music with some basic controlls. Significant WIP.

🖥 Development Instructions

It is strongly recommended you make two applications/bots. One will be the actual bot used in production environments, while the other will be for development purposes. This allows you to safely develop and test your bot without impacting the bot that will be active in multiple other servers. In this case, please perform steps 1-4 below twice - once for the production bot and another for the development bot.

If you only plan on hosting a development bot and don't intend on distributing it globally, you can only create one bot/application by following the steps below, and following the rest of the instructions for using the dev environment.

📱 Making a Discord Bot and Getting Credentials

Create a Discord application and bot by following the official Discord.js documentation. Be sure to make a note of the bot's TOKEN.
Open the OAuth2 tab and, under SCOPES, enable bot and application.commands.
Invite the bot to your server by following the official documentation. Use the same scopes selected in the previous step.
On the Discord Developer Portal, navigate to your application and from the "General Information" tab, copy your APPLICATION ID. This will be the CLIENT_ID later.
Enable Developer Mode on Discord by:
1. Open up the Discord app
2. Click on the settings cog in the bottom left corner
3. Go to Advanced
4. Enable Developer Mode
5. Exit settings
Right-click on your server from the left and click "Copy ID." This will be the guildId later.

🛠 Getting set up

Clone the repository
Create a new file called .prod.env in the root of the repository and enter the following fields you took note of earlier. Note that this should be the information for the production bot. GUILD_ID may be omitted for the production bot if commands are to be deployed globally.
```
CLIENT_ID=<clientId>
GUILD_ID=<guildId>
TOKEN=<token>
```
If you are using a different development and production bot, create another file called .dev.env in the root of the repository and enter the information for the development bot.
If it is not already there, create a new file called .gitignore and include:
```
  node_modules/
  *.env
```
Run npm install

📝 Adding/Editing Commands

Commands can be created and edited in the commands folder using the appropriate command file. See question.js as an example.

Any time new commands are created, they need to be registered. To do so, run npm run commands. This will deploy the commands to your development server only. See Deploying your Commands below for more information.

🤖 Starting the bot

To run the bot, run the command npm start. This will run the bot in a production state, meaning it will not deploy your commands for you. To deploy your global commands for production, see Deploying your Commands below for more information.

To start the development bot, use npm run dev. This will start the bot locally on your machine and also automatically deploy the commands to your development server.

To stop the bot, press CTRL-C

📤 Deploying your Commands

When you modify the name or description of your commands, or add/remove commands, the changes may not be reflected immediately after starting the bot. To get around this, you can use a GitHub Action to automatically deploy your commands when merging to main, or manually running a script to deploy the commands.

🔄 Automatically Deploy Commands with GitHub Actions

The deploy-commands.yml file contains the code necessary for automatically deploying your bot's commands every time a commit is pushed to main or a PR is merged. To configure this, you will need to set up Repository Secrets. To do so, navigate to your repository's Settings and go to Secrets > Actions. If you have not yet created an environment, make a prod environment. Click "New Repository Secret" to create a new secret. You will need to create the same secrets that you entered in your .env file: CLIENT_ID, GUILD_ID, and TOKEN. Make sure that you are using the keys for your production bot/application.

To disable this functionality, you can delete the deploy-commands.yml file and commit the change to main. Otherwise, this can remain and you can still deploy commands manually (see below) without causing any conflicts.

📬 Manually Deploy Commands

If you are developing locally and would like to test commands without committing them, you can do so by running npm run commands command from the root of your directory. A confirmation message will appear in the console. If you use npm run dev the development commands are automatically deployed and you do not need to run this command.

If you choose to not deploy your production commands automatically, you can manually do so by running node deploy-commands.js prod. This will globally deploy your bots production commands from the commands folder across Discord. It may take up to an hour for the updates to be reflected due to Discord caching global commands.

davidthehat / DiscordWordleBot

readme