[Codex Studios] : Core
📚 Codex Core Explanation
Last updated
Was this helpful?
📚 Codex Core Explanation
Last updated
Was this helpful?
Codex Core is a powerful resource used to manage and control the integration of our scripts with the Vorp and RSG frameworks. It serves as a bridge between these frameworks and helps streamline updates and maintenance.
Framework Support: Codex Core supports Vorp Core and RSG Framework, making it easy for us to update and maintain our scripts.
Centralized Control: With Codex Core, if there’s a major update in the Vorp core (for example), we only need to make the necessary changes to Codex Core, rather than updating each individual script. This saves a lot of time and ensures consistency across all your scripts.
Efficiency: Instead of updating scripts manually for each framework (Vorp or RSG), Codex Core handles the heavy lifting, allowing you to focus on writing and improving your scripts.
Codex Core is not a "framework" by itself, but rather a tool that enhances the functionality of existing frameworks (Vorp Core and RSG Framework).
Codex Core does not convert scripts from one framework to another.
It does not convert a script from RSG to Vorp or vice versa.
Codex Core is a helper, not a standalone framework. It requires either Vorp Core or RSG Framework to function properly.
If you have an open-source script and want to integrate it with Codex Core, follow these steps:
Before you begin, make sure your script is compatible with Vorp Core or RSG Framework. Codex Core will only work with these two frameworks.
Follow these steps to integrate your script with Codex Core:
Step 1: Identify Framework Dependencies
Your script must support either Vorp Core or RSG Framework.
Codex Core will automatically manage and update the integration when needed.
Step 2: Add Codex Core Module
Include Codex Core as a dependency in your resource manifest (fxmanifest.lua).
Ensure your script references Codex Core for database handling, settings, and module loading.
Step 3: Modify Database Calls (if applicable)
Codex Core provides an easy interface for interacting with different SQL resources (e.g., oxmysql, ghmattimysql, mysql-async). Modify your script to use Codex Core for database queries.
Test the Integration: Once you’ve made the necessary changes, ensure your script works smoothly with Codex Core and that it integrates seamlessly with the chosen framework (either Vorp or RSG).
Debugging: If you encounter issues during integration, review the Codex Core Logs and Framework Logs to help identify potential conflicts.
After testing your script, deploy it as usual! Codex Core will handle the framework-related functionality.
Codex Core simplifies the integration process with the following features:
Codex Core supports multiple SQL resources such as:
oxmysql
ghmattimysql
mysql-async
By default, Codex Core will automatically detect(You must define it in Core Config) and use the configured SQL resource, so you don't need to worry about managing SQL connections for each script.
Codex Core allows for modular loading of scripts. This makes it easier to organize and manage different parts of your resource, especially when dealing with large scripts.
With Codex Core, you can manage settings for your script from a centralized settings menu, allowing for quick configuration changes without touching the script code directly.
Codex Core is designed to save you time and effort when working with Vorp and RSG frameworks. It allows for centralized control, efficient updates, and better maintenance practices across all your scripts.
Whether you’re working with an open-source script or creating a new one, Codex Core is the perfect solution to ensure your script integrates smoothly with both frameworks .
