https://github.com/materiiapps/mai
the cutest materii bot
https://github.com/materiiapps/mai
Last synced: 8 months ago
JSON representation
the cutest materii bot
- Host: GitHub
- URL: https://github.com/materiiapps/mai
- Owner: MateriiApps
- License: gpl-3.0
- Created: 2023-07-21T03:06:20.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-24T18:38:34.000Z (8 months ago)
- Last Synced: 2025-02-24T19:28:07.372Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 137 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mai
the cutest materii bot
This is a specialized bot for the Materii discord so you likely will find no purpose for it.
## Running
### Docker
This handles automatically updating as well.\
Prebuilt images are for `linux/amd64`, `linux/arm64/v8`
```shell
$ git clone https://github.com/MateriiApps/mai-docker
$ cd mai-docker
$ ./up.sh
```
### Manually
```shell
$ git clone https://github.com/MateriiApps/mai
$ npm i -g pnpm # pnpm better
$ pnpm i
# Set all env vars
$ export xxx=yyy
$ pnpm start
```
## Config
| name | type | description |
|--------------------|-------------|-------------------------------------------------------|
| `DISCORD_TOKEN` | string | Discord bot token |
| `GITHUB_TOKEN` | string | Readonly Github PAT for fetching MateriiApps info |
| `OWNERS` | Snowflake[] | User id list separated by comma |
| `ANDROIDX_CHANNEL` | Snowflake | Channel id for sending androidx release changelogs in |
| `ANDROIDX_ROLE` | Snowflake | Role id to mention with the aforementioned changelogs |
| `AGE_REQUIREMENT` | string | Account age requirement to not be kicked. ex. `2d` |
| `LOG_LEVEL` | LogLevel | String key of [LogLevel] |
[LogLevel]: https://github.com/sapphiredev/framework/blob/4f3a2cbb586bd96dae4966297c63ebfd616f5746/src/lib/utils/logger/ILogger.ts#L4-L39