Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ohmrr/quabos
Discord.js v14 bot made with TypeScript. Uses a markov chaining algorithm to create new strings from a dataset of messages from servers.
https://github.com/ohmrr/quabos
chatbot discord-js-v14 discordjs nodejs typescript
Last synced: about 2 months ago
JSON representation
Discord.js v14 bot made with TypeScript. Uses a markov chaining algorithm to create new strings from a dataset of messages from servers.
- Host: GitHub
- URL: https://github.com/ohmrr/quabos
- Owner: ohmrr
- License: other
- Created: 2024-02-11T07:46:29.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T02:34:20.000Z (about 2 months ago)
- Last Synced: 2024-10-24T09:44:03.682Z (about 2 months ago)
- Topics: chatbot, discord-js-v14, discordjs, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 713 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quabos
## Project Description
Quabos is an entertainment-focused Discord bot designed to promote activity in your Discord server. Using a Markov Chaining algorithm, Quabos will use messages previously sent to your server to generate new ones.
## Setup Instructions
### Installing Dependencies
To install the necessary dependencies, run the following command in the root directory of the project:
```bash
pnpm install
```
### Configuring Environment Variables
Create a `.env` file in the `packages/bot` directory and add the following environment variables:
```
DISCORD_TOKEN="your_discord_bot_token"
DATABASE_URL="your_database_url"
NODE_ENV="production"
DEV_GUILD_ID=""
```
Replace `your_discord_bot_token` with your actual Discord bot token and `your_database_url` with your MongoDB connection URL.
`NODE_ENV` must be either "production" or "development". If you wish to deploy the slash commands to a development guild, `DEV_GUILD_ID` must be properly set with the ID of that guild.
## Usage Examples
### /avatar
Displays the avatar of the selected server member.
```
/avatar [user]
```
### /config
Manages bot configuration.
#### /config channels add
Adds a new channel for reading messages.
```
/config channels add [channel]
```
#### /config channels list
View the list of channels being read for messages.
```
/config channels list
```
#### /config channels remove
It removes a channel from which Quabos reads messages.
```
/config channels remove [channel]
```
### /help
Shows command information.
```
/help [command]
```
### /info
Information about Quabos and the current guild.
#### /info bot
Shows information about Quabos.
```
/info bot
```
#### /info stats
Shows Quabos's stats for the current server.
```
/info stats
```
## Contributing
We welcome contributions to the Quabos project! Here are some guidelines to help you get started:
### Reporting Issues
If you encounter any issues or bugs, please report them by creating a new issue on the [GitHub repository](https://github.com/ohmrr/quabos/issues). Provide as much detail as possible to help us understand and resolve the issue.
### Submitting Pull Requests
If you would like to contribute code to the project, follow these steps:
1. Fork the repository on GitHub.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with clear and descriptive commit messages.
4. Push your changes to your forked repository.
5. Create a pull request on the main repository, describing your changes and the problem they solve.
We will review your pull request and provide feedback. Once approved, your changes will be merged into the main repository.
Thank you for contributing to Quabos!