This repository contains the official documentation for Mythic Framework - a sophisticated, modular FiveM roleplay framework built with scalability, maintainability, and extensibility in mind.
The documentation is built with Mintlify and covers everything from installation and core concepts to comprehensive API references and advanced development guides.
- Installation Guides - Step-by-step setup instructions
- Quickstart - Get up and running in minutes
- Interactive Tools - Item generators, color pickers, and more
- Architecture - Understanding the framework's design
- Component System - Modular, reusable components
- Proxy Pattern - Dependency injection and component management
- Event System - Event-driven communication patterns
- Database Architecture - Dual MongoDB/MySQL setup
- UI Framework - React + Redux with NUI bridge
Complete API documentation for:
- Core API - Base, Fetch, Callback, Logger, Database, Middleware
- Characters - Character management and progression
- Inventory - Slot-based inventory system
- Jobs - Employment and job management
- Vehicles - Ownership, keys, and garage systems
- Server configuration
- Database connections
- Discord webhooks
- Resource management
- Permissions system
- Environment variables
- Mintlify - Documentation platform
- MDX - Markdown with JSX components
- React - Interactive components and snippets
- Tailwind CSS - Styling
- Node.js 18+ and npm
- Git
-
Clone the repository
git clone https://github.com/Mythic-Framework/mythic-docs.git cd mythic-docs -
Install Mintlify CLI
npm i -g mintlify
-
Start the development server
mintlify dev
-
View the docs
Open http://localhost:3000 in your browser
The documentation is organized as follows:
[MYTHIC-DOCS]/
├── introduction.mdx # Home page
├── quickstart.mdx # Quick start guide
├── interactive-tools.mdx # Interactive utilities
├── installation/ # Installation guides
├── concepts/ # Core concepts
├── configuration/ # Configuration guides
├── api/ # API reference
│ ├── core/ # Core API
│ ├── characters/ # Characters API
│ ├── inventory/ # Inventory API
│ ├── jobs/ # Jobs API
│ └── vehicles/ # Vehicles API
├── snippets/ # Reusable React components
├── images/ # Documentation images
└── docs.json # Mintlify configuration
Contributions are welcome! If you'd like to improve the documentation:
- Fork the repository on GitHub
- Make your changes in your fork
- Test locally (optional but recommended)
mintlify dev
- Submit a Pull Request from your fork
That's it! We'll review your changes and merge them if everything looks good.
- Use clear, concise language
- Include code examples for technical content
- Use MDX components (
<Card>,<Warning>,<Tip>, etc.) appropriately - Follow the existing documentation structure
- Test all code examples before committing
The docs include several custom interactive components:
- Item Generator - Generate item definitions for the inventory system
- Color Generator - Create color palettes for UI customization
- More coming soon!
This documentation is licensed under the MIT License.
The Mythic Framework itself is a separate project with its own license.
Created with ❤️ by Artmines
Full Stack Developer passionate about creating robust, scalable solutions for the FiveM community. This documentation was built with love for the Mythic Framework community to help developers build amazing roleplay experiences.
Join the Mythic Framework community:
- Discord: discord.gg/94apejXRe5
- GitHub: github.com/Mythic-Framework
- Mintlify - For the amazing documentation platform
- Mythic Framework Team - For building an incredible framework
- Community Contributors - For feedback and improvements
Made with ❤️ for the Mythic Community