The official comprehensive documentation for RSG Framework - A complete RedM roleplay framework.
Live Documentation: https://rsg.mintlify.app/homepage
This documentation provides complete guides, API references, and tutorials for developing with RSG Framework.
- Installation guides (Windows & Linux)
- Framework configuration
- First resource creation
- Server Functions - 50+ server-side functions with examples
- Client Functions - 40+ client-side functions with examples
- Events - Complete event system documentation
- Player Data - Player structure and manipulation
- Callbacks - Asynchronous callback system
- Commands - Command registration and handling
- Complete inventory API reference (35+ exports)
- Meta items guide with real use cases
- Weapons integration
- Weight and slot mechanics
- Database structure
- Getting started with Lua for RedM
- Events & callbacks mastery
- Threads & loops best practices
- Common RSG patterns and examples
- ox_lib integration guides
- ox_target reference
- RedM natives reference
This documentation serves as both:
- API Reference - Quick lookup for experienced developers
- Learning Resource - Comprehensive guides for beginners
We believe in providing not just what functions exist, but how to use them effectively with real-world examples from the RSG Framework codebase.
We welcome contributions to improve the documentation! If you find errors, have suggestions, or want to add examples:
- Fork this repository
- Create a feature branch (
git checkout -b feature/improvement) - Make your changes
- Commit your changes (
git commit -m 'Add some improvement') - Push to the branch (
git push origin feature/improvement) - Open a Pull Request
- Ensure all code examples are tested and working
- Follow the existing documentation structure and style
- Include practical examples from real RSG Framework usage
- Keep explanations clear and beginner-friendly
- Mintlify - Documentation platform
- RSG Framework - The framework being documented
- RSG Framework GitHub: https://github.com/Rexshack-RedM
- RexShack GitHub: https://github.com/RexShack
- Discord Community: Join our Discord
- RedM Natives: https://rdr3natives.com/
This documentation is licensed under the MIT License - see the LICENSE file for details.
- RSG Framework Team - For creating and maintaining the framework
- Documentation Contributors - For improving and expanding the guides
- Mintlify - For providing the documentation platform
- RedM Community - For continuous support and feedback
Need help? Have questions?
- Join our Discord Server
- Check the Documentation
- Open an issue on this repository
Made with ❤️ for the RSG Framework community
