Skip to content

Latest commit

 

History

History
134 lines (103 loc) · 5.57 KB

README.md

File metadata and controls

134 lines (103 loc) · 5.57 KB


Cabot
Cabot

Your Digital Guide to the Occult

A versatile, open-source Discord bot for divination, occult studies, and spiritual guidance.
Powered by JavaScript, Discord.js, and Node.js runtime.

✨ Features • 🌐 Localization • 🤝 Contributing • 📅 Roadmap

✨ Features & Commands

Divination Commands

  • Fortune Telling: 8ball, Fortune, Tarot, Pendulum
  • Runes: Rune, CastRunes
  • Other Tools: Bibliomancy, Coin Flip, Geomancy, I-Ching, SpectralCross, Psychic, Roll
  • Esoteric Search: Hieroglyphs

Occult Commands

  • Celestial Insights: Horoscope, Moon
  • Symbolic Craft: Sigil, Find

Spiritual Commands

  • Sacred Texts: Bible, Mythology
  • Mystic Numbers: Numerology

📜 Changelog & Technical Reports

Update Log

For a complete changelog of Cabot's updates, including new features, fixes, and improvements, see the UPDATE.md.

Technical Report

For an in-depth look at Cabot's technical architecture, features, and design elements, refer to the TECHREPORT.md.

🌐 Localization (Locales)

Cabot currently supports the following languages:

  • 🇺🇸 English (en)
  • 🇧🇷 Brazilian Portuguese (pt_br)
  • 🇪🇸 Spanish (es_latam)

Note: Cabot relies on extensive datasets, which makes full translations challenging. Additional languages will only be added with community support.

Commands Not Supported by i18n

The following commands are currently excluded from the i18n system due to dataset or technical limitations:

Command Reason
Bibliomancy Data retrieved via APIs.
CastRunes Complex systems and dataset structures.
I-Ching Large dataset still in progress.
Hieroglyphs Field complexity and search functionality limitations.
Tarot Extensive dataset still undergoing translation.
Find High complexity; future localization possible.
Horoscope Relies on multiple APIs.
Moon Uses hardcoded data; refactoring needed for localization.
Bible API-based data retrieval.
Mythology Newly added; data is still being developed.

🤝 Contributing to Locales

We welcome community contributions! Here's how you can help:

  1. Use /locales/en as the base template.
  2. Create a new folder for your language under /locales (e.g., locales/fr for French).
  3. Translate all files while maintaining the structure and naming conventions of the English locale.
  4. Do not translate placeholders enclosed in {{ }} or hyperlinks.
  5. Submit your translations as a pull request for review.

📅 Project Roadmap

Completed

  • ✅ Add Tarot images
  • ✅ Test Tarot image reversals
  • ✅ Add I-Ching and Geomancy images
  • ✅ Merge CastRunes with base rune data
  • ✅ Add support for Ogham, Witches, and Mixed runes in CastRunes
  • ✅ Update emojis for CastRunes
  • ✅ Implement i18n language system
  • ✅ Add translations for:
    • English
    • Spanish
    • Brazilian Portuguese

Ongoing and Upcoming

  • 🚧 Add new Tarot decks
  • 🚧 Develop scheduled task embed types
  • 🚧 Develop quiz command
  • 🚧 Curate Card of The Day data
  • 🚧 Improve The Cabot Learn System

🎉 Show Your Support

If you find Cabot helpful:

  • ⭐ Give it a star on GitHub.
  • 💬 Join the Support Server to share ideas, report issues, or get help.
  • 📢 Spread the word to help Cabot grow!

📄 License

Cabot is open-source software licensed under the GNU Affero General Public License (AGPL) v3.0.
This license ensures that Cabot remains freely available while encouraging contributions and collaboration.

💡 Developed with the care and support of the Cabot community. Join us on Discord!