FiveM Plugin
The FiveM Server object is a specialized configuration container designed to integrate Grand Theft Auto V roleplay communities directly into your Custom Game Launcher. While it appears as a static icon or custom image on your launcher page, it functions as the central data hub for your server's connection credentials.
By using this object, you eliminate the need for players to manually search for your server or type in IP addresses. It stores the necessary connection strings so that a single click from a separate button can trigger a seamless transition from the launcher directly into your world.
The FiveM Server object requires the FiveM Plugin to be active within your workspace. It is compatible with both Gamer and Developer editions.
FiveM Settings Overview
Once placed on your page, the FiveM Server object provides a streamlined properties panel to define how the Custom Launcher should communicate with the game client.
Connection Settings
- Server IP/Host: The numerical IPv4 address or the DNS hostname (e.g., cfx.re/join/xxxxxx) of your FiveM server.
- Port: The network port utilized by your server instance. By default, FiveM uses 30120.
FiveM Events
The FiveM Server object is a non-interactive data object and does not possess its own events. It is designed to hold configuration data that is called upon by other interactive objects like standard Buttons or Image Buttons.
FiveM Actions
To initiate a connection to your server, you must use the specific action tied to the FiveM plugin via another object's event (such as a Play Button).
| Action | How it works |
|---|---|
| Connect to FiveM Server | Communicates with the FiveM client to launch the game and automatically join the IP and Port defined in the target FiveM object. |
Building Logic with FiveM
Since the FiveM object acts as the data source, you will typically pair it with a visual "Play" button to create a professional entry sequence for your Custom Game Launcher.
Example 1: The One-Tap Join Button
The most efficient way to get users into your FiveM server is by linking a styled button to the FiveM object data.
- Drag a FiveM Server object onto your page. In the properties, enter your Server IP and Port.
- Place a standard Button or Image Button on the page to act as your "Connect" button.
- On the Button's onClick event, select the action Connect to FiveM Server.
- Target the FiveM Server object you created in step 1.
- When players click your button, the launcher will automatically trigger the FiveM client and join your server.
Custom CSS Example
Users of the Developer Edition can apply high-end visual polish to the FiveM object icon using Custom CSS. This is perfect for adding glow effects or glassmorphism to your Custom Launcher design.
Do not use !important on structural properties such as width, height, or position, as these are handled by the internal layout engine. Custom CSS should focus on visual overlays and effects.
The preview above demonstrates how Custom CSS transitions and filters can make a static plugin icon feel responsive and high-quality. Hover over the icon to see the effect.
/* Developer Edition Custom CSS for FiveM Object */
/* Adding a modern rounded aesthetic and soft glow */
border-radius: 15px !important;
border: 1px solid rgba(255, 255, 255, 0.1) !important;
transition: all 0.4s ease !important;
/* Interactive hover state for visual feedback */
:hover {
box-shadow: 0 0 20px rgba(255, 126, 41, 0.5) !important;
filter: brightness(1.2) !important;
}
Summary
The FiveM Server object is the essential link between your roleplay community and the game client. By centralizing your server's connection details into this object, you create a fail-proof "one-click" experience within your Custom Game Launcher, ensuring your players spend less time in menus and more time in-game.