Getting Started

This guide explains how to create and run a server. If you only want to join and play on an existing server, this page is not required.

Getting Started

Overview

Setting up a server involves four main steps:

1. Download the server package from the Downloads page.
2. Extract the files to a new, empty folder.
3. Configure your server settings in server.xml (see Server Configuration).
4. Start the server executable.

Executable names:

• Windows: Server.exe
• Linux: See Linux Server for available launch methods and instructions.

Once started successfully, the server will begin listening for incoming connections.

Server Configuration

All core settings are stored in server.xml. This includes:

• Server name
• Port settings
• Resource loading
• Player limits
• Networking options

Refer to Server Configuration for a full list of available settings and explanations.

After modifying the configuration, restart the server for changes to take effect.

Game Mode Setup

GTA IV (Rockstar Modes)

To use Rockstar’s built-in game modes (Party Mode sessions):

1. Navigate to the resources folder.
2. Delete the freeroam folder.
3. Open server.xml.
4. Remove the line:

<resource src="freeroam" />

Start the server normally.

Players who connect will enter a generic rendezvous lobby using Party Mode. From there:

• Players can use the in-game phone.
• Sessions can be created or joined directly.

GTA III, Vice City, San Andreas, and IV (Custom / Scripted Modes)

For scripted servers:

• Example scripts are available here:

 v-essentials examples

If creating your own scripts, you must at minimum:

• Spawn the player.
• Fade in the camera using gta.fadeCamera.
• Trigger this logic in an appropriate event, such as onPlayerJoined.

The default freeroam resource:

• Handles spawning and camera fade.
• Is designed for GTA III.
• May require modification for other games.

We also provide a Minimal Resource Skeleton that you can use to start on your own.

Resources

Resources control gameplay logic, scripts, and custom functionality.

See Resources for:

• Resource structure
• Loading and unloading
• Script organization
• Best practices

Modules

Modules extend server functionality with native integrations such as:

• MySQL
• SQLite
• INI file handling
• Additional system-level features

See Modules for usage instructions.

Additional modules are available on the forum: Modules Board

Developers with C or C++ experience can create custom modules using the: Module SDK

Server Manual

For in-depth documentation covering commands, configuration, scripting, and advanced topics, see the Server Manual.

Next Steps

After your server is running:

• Verify connectivity (see port forwarding documentation if hosting from home).
• Test resource loading.
• Confirm players can join successfully.
• Begin developing or installing additional resources and modules.