Main Page

Gothic 1 Remake Multiplayer

G1R:MP Scripting Wiki

Build multiplayer resources and gamemodes with Lua 5.1. This wiki documents the server, client, networking, gameplay, database, and RmlUi APIs exposed by G1R:MP.

Lua 5.1 • server and client resources • authoritative gameplay • RmlUi

SCRIPTED CAMERA — AVAILABLE FROM UPDATE 0.1.3

15 camera functions and 2 client camera events are available from G1R:MP 0.1.3. Build login backgrounds, fixed shots, smooth transitions, paths and orbits. See Scripted camera for examples, limits and client/server differences.

Client and server (10): setCameraPos • setCameraRot • setCameraLookAt • setCameraFOV • setCameraPose • moveCameraTo • playCameraPath • orbitCamera • stopCameraMovement • resetCameraPos

Client read-back (5): getCameraPos • getCameraRot • getCameraFOV • getCameraState • requestCameraState

Client events (2): onClientCameraCommandResult • onClientCameraReset. Client commands use asynchronous acknowledgements; server calls return only a queued boolean.

AVAILABLE AND IMPROVED FROM UPDATE 0.1.2

The following 40 Lua functions — 29 server-side and 11 client-side — are available from G1R:MP 0.1.2. Existing lifecycle, inventory, JSON, NPC, monster, and world-item APIs also include corrected or expanded behavior from this update.

Accounts and consumables (4): completePlayerConsumableFinalize • completePlayerConsumableUse • getPlayerAccountBindingSerial • getPlayerConsumableNames

World items (1): spawnItem — see also the World item catalog.

Monster identity, health, and combat (5): setMonsterName • setMonsterIdVisible • setMonsterMaxHealth • getMonsterAttackDamage • setMonsterAttackDamage

Monster navigation (6): setMonsterNavigationMode • setMonsterNavigationCollisionMode • setMonsterMoveGoal • stopMonsterMovement • testMonsterMove • walkMonsterTo

NPC identity and navigation (7): setNpcIdVisible • setNpcObstacleBehavior • setNpcNavigationMode • setNpcNavigationCollisionMode • setNpcMoveGoal • stopNpcMovement • testNpcMove

Custom navigation blockers (6): createAiNavigationBlocker • updateAiNavigationBlocker • setAiNavigationBlockerEnabled • destroyAiNavigationBlocker • getAiNavigationBlockerData • getAiNavigationBlockers — see NPC and monster navigation collision.

Client audio (11): playSound • playSound3D • stopSound • setSoundVolume • getSoundVolume • setSoundPaused • isSoundPaused • isSoundPlaying • setSoundLooped • setSound3DPosition • setSound3DMinMaxDistance — see Client audio.

Events available from 0.1.2 (8): onNpcIdVisibilityChange • onMonsterNameChange • onMonsterIdVisibilityChange • onMonsterMoveBlocked • onMonsterMoveComplete • onNpcMoveBlocked • onNpcMoveComplete • onWorldItemDrop. Existing onPlayerJoin, onPlayerQuit, onWorldItemPickup, and onWorldItemSpawn contracts are also improved from 0.1.2.

Start here

Find the right entry point for your first resource.

• Lua API overview
• Complete function catalog
• Complete event and callback catalog
• Validated skin, monster, equipment, and gameplay keys
• NPC and monster navigation collision
• Client audio and synchronized 3D playback
• Scripted camera and moving login backgrounds (0.1.3)
• Resource lifecycle functions
• Lua examples
• Hosting a dedicated server
• Experimental API status

Reference by execution side

Check where a function is available before using it.

• Server-side functions
• Client-side functions
• Client audio functions
• Shared functions
• Server-side events
• Client-side events
• Event functions
• Network functions

Gameplay

Players

Position and spawn

Progression

Inventory

Equipment

Magic

Health and life state

World time and weather

Monsters

AI navigation

Interactions

Scripting systems

RmlUi and GUI

Database

Known MySQL/MariaDB issue

Timers

Commands

Chat

Animations

Client audio and OGG playback

Camera

Events and callbacks

Your first server script

The following example welcomes a joining player and places them at an authoritative spawn point:

addEventHandler("onPlayerJoin", root, function(playerId)
    setPlayerName(playerId, "Newcomer")
    spawnPlayer(playerId, 12.0, 24.0, 2.0, 90)
    outputChatBox("Welcome to G1R:MP!", playerId, 225, 195, 110)
end)

See onPlayerJoin, addEventHandler, setPlayerName, spawnPlayer, and outputChatBox for parameter details and additional examples.

Community

• G1R:MP website
• Community forum
• Project lead: QCherry

Documentation status

The reference contains 291 Lua functions and 94 events, including 15 camera functions and 2 camera events available from update 0.1.3. Version notices distinguish newly available APIs from improved contracts in earlier APIs. See Lua API catalogs for validated skin, monster, equipment, progression, and gameplay keys, and Scripted camera for camera state and lifecycle rules. APIs marked experimental may still change while the multiplayer runtime is under active development.