Core
The CMS Core maintains common utility functions and push event handling.
Looking for VPS, web, or dedicated hosting? Check out our official server hosting!
This resource does nothing on its own and is simply a dependency for other resources.
Installation
1. Download the Resource
Click here to download the core resource.
2. Install the Resource
Extract the [sonorancms] folder into your server's resources folder.
3. Configure and Rename
Open sonorancms\config.CHANGEME.lua
, update the values, then save it as config.lua
.
Default configuration is below:
Configuration Details
Config Option | Description |
---|---|
APIKey | API Key found in the API Integration section of the Administrative Panel |
CommID | Community ID found in the API Integration section of the Administrative Panel |
allowAutoUpdate | When enabled, the resource will update itself. When disabled, it will simply show an update notification every 2 hours. |
debug_mode | When set to |
apiUrl | Default: |
apiIdType | Type of api ID the core script should be searching for: |
serverId | Default: |
framework |
|
MaxInventorySlots | If using framework: |
restartWithPlayers | When set to |
4. Server Config
Add the following to your server.cfg
It is very important that the sonorancms_updatehelper resource is not started manually. Doing so may cause a server crash if updates are available due to a race condition.
DO NOT start the whole [sonorancms] folder as that will also start the sonorancms_updatehelper which might cause crashing if it is started manually.
Example of what not to do: ensure [sonorancms]
Submodules
The CMS Core resource comes with a variety of submodules included by default. These handle a variety of features such as whitelisting, permission synchronization, and more.
You can view the submodules and our guides for configuring them here.
Updates
Sonoran CMS's core will automatically update with the latest features, fixes, and changes!
Troubleshooting
Server Crashes
Check to make sure sonorancms_updatehelper
is not being started in your server.cfg.
It is very important that the sonorancms_updatehelper
resource is not started manually. Doing so may cause a server crash if updates are available due to a race condition.
Ensure your resource is up-to-date and download the latest release.
CMS updates are released often. Make sure your server is running on the latest release.
Ensure your API ID is set correctly.
If your community is using recommended Discord integration, ensure your Discord account is linked.
For other methods (Steam, FiveM License, etc.) ensure you have set your API ID in the CMS using the API ID that your community is looking for.
Yarn Error
Some users will see this in their server console:
In the case of this error, please locate the file named .yarn.installed
, open it in any editor, then save it (without modifying anything).
This updates the "date modified" value for that file, which should then allow it to build correctly.
If you are having trouble with this, feel free to reach out to us, our support team will be happy to help you!
Last updated