📖 Grimoire

Grimoire is a modern worldbuilding application designed to help creators, writers, and game masters bring their worlds to life. Built with Laravel and React, Grimoire combines powerful editing tools, AI-driven features, and a vibrant community to make worldbuilding more interactive and inspiring than ever.

---

✨ Features (Planned)

• Flexible Editors
  Use Canvas, Markdown, or Text style editors to craft and organize your worldbuilding notes.

• Custom Templates
  Create and manage Settings, Locations, Characters, Gods, Creatures, Monsters, Items, and more with optional templates tailored to your needs.

• Explorer Mode
  Interact with your world by exploring locations through uploaded or AI-generated art in our immersive Explorer.

• AI Character Chat
  Chat with the characters you've designed, powered by advanced AI, to deepen your stories and interactions.

• Sharing & Collaboration
  Share specific assets or your entire setting with others, enabling collaboration and feedback.

• Community Library
  Find inspiration and discover other worlds in the community Library.

• Integrations
  Seamlessly integrate with popular worldbuilding tools like Obsidian and more.

---

🚀 Getting Started

Note: Grimoire is currently in development. Stay tuned for installation instructions and early access!

Deployment

Grimoire is proud to deploy on Laravel Cloud!

Development Setup

1. Clone the repository

   git clone https://github.com/yourusername/grimoire.git
   cd grimoire

2. Install PHP dependencies

   composer install

3. Install JavaScript dependencies

   pnpm install

4. Configure environment

   • Copy .env.example to .env and update settings as needed.
   • Generate an application key:

     php artisan key:generate

5. Run the development servers

   # Start Laravel backend
   php artisan serve
   
   # In a new terminal, start the React frontend (via Vite)
   pnpm run dev

---

🛠️ Tech Stack

• Backend: Laravel (PHP)
• Frontend: React, Vite, Tailwind CSS
• UI Libraries: shadcn & Radix UI, Ombre UI
• AI & Integrations: Planned for future releases

---

📄 License

This project is not currently licensed for public use or redistribution. All rights are reserved by the author.

---

📬 Stay Connected

• Project Website (still v0.1 for now; v1.0 under development...)
• Community Discord (coming soon)

---

Legacy v0.1

See legacy branch for previous Nuxt build of the app.

---