123 lines
3.6 KiB
Markdown
123 lines
3.6 KiB
Markdown
<div align="center">
|
|
<img width=15% alt="JARVIS" src="https://git.zevaryx.com/stark-industries/jarvis/jarvis-bot/-/raw/main/jarvis_small.png">
|
|
|
|
# Just Another Rather Very Intelligent System
|
|
<br />
|
|
|
|
|
|
[]()
|
|
[](https://git.zevaryx.com/stark-industries/jarvis/jarvis-bot)
|
|
[](https://discord.gg/VtgZntXcnZ)
|
|
</div>
|
|
|
|
|
|
Welcome to the JARVIS Initiative! While the main goal is to create the best discord bot there can be, a great achievement would be to present him to the Robots and have him integrated into the dbrand server. Feel free to suggest anything you may think to be useful… or cool.
|
|
|
|
**Note:** Some commands have been custom made to be used in the dbrand server.
|
|
|
|
## Features
|
|
JARVIS currently offers:
|
|
|
|
- 👩💼 **Administration**: `verify`, `ban/unban`, `kick`, `purge`, `mute/unmute` and more!
|
|
- 🚓 **Moderation**: `lock/unlock`, `lockdown`, `warn`, `autoreact`, and also more!
|
|
- 🔗 **Social Media**: `reddit` and `twitter` syncing!
|
|
- 🔧 **Utilities**: `remindme`, `rolegiver`, `temprole`, `image`, and so many more!
|
|
- 🏷️ **Tags**: Custom `tag`s! Useful for custom messages without the hassle!
|
|
- 👑 **dbrand**: `ctc2` and other dbrand-specific commands. [Join their server](https://discord.gg/dbrand) to see them in action!
|
|
|
|
|
|
## Contributing
|
|
|
|
Before **creating an issue**, please ensure that it hasn't already been reported/suggested.
|
|
If you have a question, please join the community Discord before opening an issue.
|
|
|
|
|
|
If you wish to contribute to the JARVIS codebase or documentation, join the Discord! The recognized developers there will help you get started.
|
|
|
|
## Community
|
|
|
|
Join the [Stark R&D Department Discord server](https://discord.gg/VtgZntXcnZ) to be kept up-to-date on code updates and issues.
|
|
|
|
## Requirements
|
|
- MongoDB 5.0 or higher
|
|
- Python 3.10 or higher
|
|
- [tokei](https://github.com/XAMPPRocky/tokei) 12.1 or higher
|
|
- Everything in `requirements.txt`
|
|
|
|
|
|
## JARVIS Cogs
|
|
|
|
Current cogs that are implemented:
|
|
|
|
- `AdminCog`
|
|
- Handles all admin commands
|
|
- `AutoreactCog`
|
|
- Handles autoreaction configuration
|
|
- `BotutilCog`
|
|
- Handles internal bot utilities (private use only)
|
|
- `CTC2Cog`
|
|
- dbrand Complete the Code utilities
|
|
- `DbrandCog`
|
|
- dbrand-specific functions and utilities
|
|
- `DevCog`
|
|
- Developer utilities, such as hashing, encoding, and UUID generation
|
|
- `GitlabCog`
|
|
- Shows Gitlab information about J.A.R.V.I.S.
|
|
- `ImageCog`
|
|
- Image-processing cog.
|
|
- `RedditCog`
|
|
- Reddit lookup and following commands
|
|
- `RemindmeCog`
|
|
- Manage reminders
|
|
- `RolegiverCog`
|
|
- Configure selectable roles
|
|
- `SettingsCog`
|
|
- Manage Guild settings
|
|
- `StarboardCog`
|
|
- Configure and add starboards and stars
|
|
- `TagCog`
|
|
- For managing tags
|
|
- `TemproleCog`
|
|
- For managing and assigning temporary roles
|
|
- `TwitterCog`
|
|
- Twitter following commands
|
|
- `UtilCog`
|
|
- Generic utilities, like userinfo and roleinfo
|
|
- `VerifyCog`
|
|
- Guild verification
|
|
|
|
|
|
## Directories
|
|
|
|
### `jarvis`
|
|
|
|
The bot itself
|
|
|
|
#### `jarvis.cogs`
|
|
|
|
All of the cogs listed above are stored in this directory
|
|
|
|
##### `jarvis.cogs.admin`
|
|
|
|
Contains all AdminCogs, including:
|
|
- `BanCog`
|
|
- `KickCog`
|
|
- `LockCog`
|
|
- `LockdownCog`
|
|
- `ModcaseCog`
|
|
- `MuteCog`
|
|
- `PurgeCog`
|
|
- `RolepingCog`
|
|
- `WarningCog`
|
|
|
|
#### `jarvis.data`
|
|
|
|
Contains data relevant to J.A.R.V.I.S., such as emoji lookups and dbrand data
|
|
|
|
##### `jarvis.data.json`
|
|
|
|
Any JSON files that are needed are stored here
|
|
|
|
#### `jarvis.utils`
|
|
|
|
Generic utilities
|