https://github.com/infinitybotlist/enfinity
Official Support/Management bot for the Infinity Bot List servers.
https://github.com/infinitybotlist/enfinity
Last synced: about 1 year ago
JSON representation
Official Support/Management bot for the Infinity Bot List servers.
- Host: GitHub
- URL: https://github.com/infinitybotlist/enfinity
- Owner: InfinityBotList
- Created: 2023-08-18T07:48:34.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T22:46:43.000Z (about 2 years ago)
- Last Synced: 2025-02-17T11:31:38.613Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 133 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Enfinity
Official Support/Management/Moderation bot for Infinity Bot List
---
## Contributions
Contributing to Enfinity Bot should be as easy as 1, 2, 3.
### Getting started
The first and most important thing is setting the env variables:
- Rename `.env.template` to `.env`
- Open the new `.env` file and fill in the needed variables
**If you are a member of the Infinity Development team you can reach out to toxic for some of the need values**
### Installing Dependencies
```shell
$ yarn install
```
You can use npm here to however it is recommended to use yarn.
### Database Setup
If you have set the needed MySQL url in the `.env` file you should now be able to execute our
database commands/scripts. The needed scripts will be listed below and should be ran in order:
- `yarn db:create` - Create a new prisma client (this is needed and should be ran immediately)
- `yarn db:format` - Format the prisma schema to check for errors or instabilities.
- `yarn db:update` - Deploy/Sync the prisma schema with your MySQL Instance.
### Starting the Bot
Starting the bot is extremely simple (if you have finished all the steps above):
- `yarn bot:build` - This command is optional in a development environment however you should test build frequently to ensure the builds wont fail in prod.
- `yarn bot:dev` - Runs the bot in a development environment using `nodemon` which will automatically restart the bot when changes are saved.
---
## Adding new Commands
Adding new commands to the bot can be kind of challenging, but if you follow our instructions you should be fine:
1. Navigate to the [template command](./source/temp/temp.cmd.ts) file
2. Copy the code found within this file
3. Navigate to the [commands directory](./source/client/commands)
4. Choose a category directory or create a new one
5. Add a new command file to the directory (ex: test.ts)
6. Paste the contents from the template command into your new command file and edit it to suit your needs