Servers/GettingStarted: Difference between revisions

← Older edit

Servers/GettingStarted (view source)

Revision as of 13:51, 23 February 2026

1,391 bytes added , Yesterday at 13:51

m

PerikiyoXD moved page GettingStarted to Servers/GettingStarted: Namespacing

PerikiyoXD

emailconfirmed

93

edits

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Getting Started}}
-{{BlueInformationBox|1=This guide is for '''creating a server.''' If you just want to join a server and play, this guide is not for you. }}
+{{BlueInformationBox|1=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.}}
-== General Stages ==
-- Download the server files on the [https://gtaconnected.com/downloads Downloads] page.<br>
+= Getting Started =
-- Unzip/extract the server files to an empty folder.<br>
-- Change settings in server.xml ([[ServerConfiguration|available settings]])<br>
-- Run the server executable. For Windows, this will be ''Server.exe''. For Linux, there are several options to do this, see the [[LinuxServer|linux server]] manual page.<br>
-== GTA IV (Rockstar Modes) ==
+== Overview ==
-First, remove the freeroam resource that comes with the server, by deleting the freeroam folder in resources. Then remove the <code><resource src="freeroam" /></code> line in [[ServerConfiguration|server config]]. The server should launch normally now, and connecting will place you into a generic rendezvous lobby, which uses party mode. You and other players who connect can use the phone in-game to start and join sessions.
-== GTA III, VC, SA, and IV (Custom Modes/Scripted) ==
+Setting up a server involves four main steps:
-There are some example scripts [https://github.com/VortrexFTW/v-essentials here]. If you're making your own scripts, at the very minimum you'll need to fade in the camera using [[gta.fadeCamera|gta.fadeCamera]] in a logical event such as in the [[OnPlayerJoined|onPlayerJoined]] event. The default resource provided with the server called "freeroam", includes spawning the player and fading the camera, but is designed for GTA 3 only.
-== Manual ==
+# Download the server package from the [https://gtaconnected.com/downloads Downloads] page.
-Check the [[ServerManual|Server Manual]] page.
+# Extract the files to a new, empty folder.
+# Configure your server settings in <code>server.xml</code> (see [[ServerConfiguration|Server Configuration]]).
+# Start the server executable.
+Executable names:
+* '''Windows:''' <code>Server.exe</code>
+* '''Linux:''' See [[LinuxServer|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 <code>server.xml</code>. This includes:
+* Server name
+* Port settings
+* Resource loading
+* Player limits
+* Networking options
+Refer to [[ServerConfiguration|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):
+# Navigate to the <code>resources</code> folder.
+# Delete the <code>freeroam</code> folder.
+# Open <code>server.xml</code>.
+# Remove the line:
+<pre><resource src="freeroam" /></pre>
+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:
+  [https://github.com/VortrexFTW/v-essentials v-essentials examples]
+If creating your own scripts, you must at minimum:
+* Spawn the player.
+* Fade in the camera using [[gta.fadeCamera|gta.fadeCamera]].
+* Trigger this logic in an appropriate event, such as [[OnPlayerJoined|onPlayerJoined]].
+The default <code>freeroam</code> resource:
+* Handles spawning and camera fade.
+* Is designed for GTA III.
+* May require modification for other games.
+We also provide a [[MinimalResourceSkeleton|Minimal Resource Skeleton]] that you can use to start on your own.
 == Resources ==
-Check the [[Resources|resources]] page for information on how to use resources.
+Resources control gameplay logic, scripts, and custom functionality.
+See [[Resources|Resources]] for:
+* Resource structure
+* Loading and unloading
+* Script organization
+* Best practices
 == Modules ==
-Modules extend the server with things like MySQL, SQlite, ini, etc. Check the [[Modules|modules]] page for information on how to use modules. There are some basic modules [https://forum.gtaconnected.com/index.php?board=24.0 on the forum]. Anybody with C/C++ skills can create a module using the [https://gtaconnected.com/downloads/ModuleSDK.7z module SDK].
+Modules extend server functionality with native integrations such as:
+* MySQL
+* SQLite
+* INI file handling
+* Additional system-level features
+See [[Modules|Modules]] for usage instructions.
+Additional modules are available on the forum:
+[https://forum.gtaconnected.com/index.php?board=24.0 Modules Board]
+Developers with C or C++ experience can create custom modules using the:
+[https://gtaconnected.com/downloads/ModuleSDK.7z Module SDK]
+== Server Manual ==
+For in-depth documentation covering commands, configuration, scripting, and advanced topics, see the [[ServerManual|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.