Installation

Install the FiveNet FiveM plugin to connect your gameserver to your FiveNet instance.

Installation Steps

To integrate FiveNet with your FiveM gameserver:

1. Download the Plugin
   • Download the FiveM plugin code from GitHub.
   • Use the latest version to avoid compatibility issues with newer FiveNet releases.
2. Install the Plugin
   • Place the plugin files in your FiveM server's resources directory.
   • Make sure the resource folder name remains fivenet unless you intentionally adjust your server configuration to match a different name.

#diff a/[builders]/yarn/yarn_builder.js b/[builders]/yarn/yarn_builder.js
@@ -43,7 +43,7 @@
            currentBuildingModule = resourceName;
            const proc = child_process.fork(
                require.resolve('./yarn_cli.js'),
-               ['install', '--ignore-scripts', '--cache-folder', path.join(initCwd, 'cache', 'yarn-cache'), '--mutex', 'file:' + path.join(initCwd, 'cache', 'yarn-mutex')],
+               ['install', '--ignore-scripts', '--ignore-engines', '--cache-folder', path.join(initCwd, 'cache', 'yarn-cache'), '--mutex', 'file:' + path.join(initCwd, 'cache', 'yarn-mutex')],
                {
                    cwd: path.resolve(GetResourcePath(resourceName)),
                    stdio: 'pipe',

3. Configure the Plugin
   • Open config/client.lua and config/server.lua.
   • Adjust the values so they match your FiveNet instance, framework, and server requirements.
   • Follow the plugin configuration page for the most important options.
4. Add Event Triggers
   • Review your existing framework and job-related plugins and add the necessary event triggers so FiveNet can collect the required activity data.
   • Not all required events are present in default ESX-based resources, so some customization may be needed.
5. Start the Plugin
   • Add the plugin to your server.cfg:

     ensure fivenet
     

   • Restart your server so the resource is loaded.

After Installation

Once the plugin is installed:

• Confirm that the plugin can reach your FiveNet instance.
• Verify that the API host and token are configured correctly.
• Test the tablet in game and confirm that expected sync and event-based features are working.