Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 3.14 KB

README.md

File metadata and controls

89 lines (63 loc) · 3.14 KB

OpenOccult Data

Welcome to the OpenOccult Data repository! This open-source project houses structured JSON datasets for use in divination, metaphysics, and occult practices. It includes categorized data for topics such as tarot, runes, crystals, and more, along with internationalization (i18n) support for multilingual accessibility. This data is used across various Open Occult's platforms and it holds all the data used by Open Occult platforms.

📂 Repository Structure

openoccult-data/ 
├── categories/ # Main data categorized by type 
│ ├── divination/ # Divination-specific data (e.g., runes, hieroglyphs) 
│ └── occult/ # Occult-specific data (e.g., botanicals, cystals, horoscope) 
│ └── spiritual/ # Spiritual-specific data (e.g., mythology) 
├── i18n/ # Internationalization files for global use 
│ ├── commands/ # Command translations 
│ ├── data/ # Data translations 
│   └── ... # Categorized Data translations 
├── metadata/ # Metadata about the repository 
│ ├── license.md # Licensing information 
│ ├── code_of_conduct.md # Developer code of conduct
│ ├── contributors.md # Contributor credits 
│ ├── contributing.md # Contributing Guide
│ └── changelog.md # Updates and version history 
└── README.md # Repository overview (this file)

📜 Key Features

  • Structured Data: Organized JSON files for topics like tarot, runes, crystals, and colors.
  • Multilingual Support: i18n folder containing translations for multiple languages.
  • Extensible: Easily add new categories or languages as needed.
  • Open Source: Freely available for personal and professional use under the included license.

🌟 Getting Started

1. Clone the Repository

git clone https://github.com/openoccult/openoccult-data.git
cd openoccult-data

2. Explore the Data

Browse the categories/ and i18n/ directories to discover the available datasets.

3. Use in Your Project

Integrate the JSON files into your own applications, tools, or research.

📖 Internationalization (i18n)

Translations for each dataset are located in the i18n/ folder, organized by category type. For example:

  • English Fortune Data: i18n/data/fortunes/en.json
  • Spanish Runes Data: i18n/data/runes/es.json

Contributions to expand translations are welcome!

🤝 Contributing

We welcome contributions from the community! If you have data or translations to add:

  1. Fork the repository.
  2. Create a new branch.
  3. Submit a pull request with your changes.

Check CONTRIBUTING.md for detailed guidelines.

📜 License

This project is licensed under the Creative Commons Attribution-NonCommercial (CC BY-NC) license. See metadata/license.md for more information.

❤️ Acknowledgments

A special thanks to all contributors and the OpenOccult community for making this possible.

📧 Contact

For questions, suggestions, or issues, please reach out via: