You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# Neeble bot
|
|
|
|
<img src="https://c.tenor.com/1HAl-cmOzswAAAAd/worms-meninblack.gif" align="center">
|
|
|
|
---
|
|
|
|
### Dependencies
|
|
|
|
- `Python>=3.8`
|
|
- `gcc` or your compiler of choice
|
|
- `python3-dev`
|
|
- Your distro's mysql library (`libmysqlclient-dev` in Ubuntu)
|
|
|
|
You can also run neeble under [docker](https://www.docker.com/) with [docker-compose](https://docs.docker.com/compose/)
|
|
|
|
---
|
|
|
|
### How to run
|
|
|
|
- Make sure you are running a SQL server instance
|
|
- Create a database named `neeble`
|
|
- Set up your environment variables with `environment/template` (You may copy the template into a new file)
|
|
- Make a file `/opt/neeble/id.stack` (or define your own with `NEEBLE_STACK_FILE`), it must contain an empty list (`[]`)
|
|
- Load environment variables with `source`:
|
|
`$ source environment/template`
|
|
|
|
##### Run it locally using python
|
|
The `Makefile` provided will do all necessary migrations and start the bot:
|
|
`$ make production`
|
|
|
|
##### Run it under python
|
|
Build and start the container with `docker-compose`:
|
|
`$ docker-compose up -d --build`
|
|
|
|
|
|
### FAQ
|
|
|
|
**Q: Quoting emojis doesn't work!**
|
|
A: Make sure, in the database neeble is using, that the columns `quote` and `user` in the table `neeble_quotes` uses collation `utf8mb4_general_ci`.
|
|
|
|
**Q: Logs talk about "unauthorized intents", what's all this about?**
|
|
A: Make sure your bot has all gateway intents enabled in the discord developer console. |