jarvis/jarvis-bot
jarvis/jarvis-bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
1086 commits 2 branches 0 tags 4 MiB
Find a file
Zevaryx 9a8501b88f [fix] Ruff in jarvis/data/units.py
2024-03-17 00:31:09 -06:00
jarvis [fix] Ruff in jarvis/data/units.py 2024-03-17 00:31:09 -06:00
.dockerignore [feat] Heavy push to Docker 2024-03-04 17:35:59 -07:00
.env.example Fix .env.example keys 2022-10-27 17:51:41 -06:00
.flake8 Fix some breakages related to beanie 2023-03-24 19:55:03 +00:00
.gitignore [fix] Pre-commit CI 2024-03-17 00:11:11 -06:00
.gitlab-ci.yml [fix] Pre-commit CI 2024-03-17 00:11:11 -06:00
.pre-commit-config.yaml [fix] Update pre-commit 2024-03-16 22:34:16 -06:00
Dockerfile [feat] Add data deletion task and command for verification 2024-03-16 20:13:38 -06:00
install.sh Swap out cloc for tokei 2021-07-15 14:35:27 -06:00
jarvis.png More logo updates 2022-02-03 14:43:21 -07:00
jarvis.service Change terminate to kill 2021-06-26 12:31:34 -06:00
jarvis.svg More logo updates 2022-02-03 14:43:21 -07:00
jarvis_small.png More logo updates 2022-02-03 14:43:21 -07:00
LICENSE Add LICENSE, PRIVACY, TERMS 2022-03-10 22:42:34 -07:00
poetry.lock [feat] Heavy push to Docker 2024-03-04 17:35:59 -07:00
PRIVACY.md [fix] Data deletion, update privacy policy 2024-03-16 21:45:17 -06:00
pyproject.toml [fix] Pre-commit CI 2024-03-17 00:11:11 -06:00
README.md [fix] Pre-commit formatting 2024-03-17 00:00:42 -06:00
requirements.precommit.txt [fix] requirements.precommit.txt 2024-03-17 00:13:59 -06:00
requirements.txt Add dockerfile 2022-10-27 20:06:34 -06:00
run.py [fix] Pre-commit formatting 2024-03-17 00:00:42 -06:00
sample.env [feat] Heavy push to Docker 2024-03-04 17:35:59 -07:00
schema.yaml Add extra checks on mute/ban/unmute loop. Add unmute command, closes #25 2021-07-02 21:26:51 -06:00
TERMS.md Add LICENSE, PRIVACY, TERMS 2022-03-10 22:42:34 -07:00

README.md

JARVIS

Just Another Rather Very Intelligent System


python 3.10+ tokei lines of code discord chat widget

ko-fi

Welcome to the JARVIS Initiative, an open-source multi-purpose bot

Features

JARVIS currently offers:

  • 👩‍💼 Administration: verify, ban/unban, kick, purge, mute/unmute and more!
  • 🚓 Moderation: lock/unlock, lockdown, warn, autoreact, and also more!
  • 🔧 Utilities: remindme, rolegiver, temprole, image, and so many more!
  • 🏷️ Tags: Custom tags! Useful for custom messages without the hassle!

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 to be kept up-to-date on code updates and issues.

Requirements

  • MongoDB 6.0 or higher
  • Python 3.10 or higher
  • 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)
  • 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