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

Current public release: G1R:MP 0.1.6 / BUILD174 / Protocol 38. Windows client and Windows/Linux dedicated server downloads are available on the Download page. Update both the client and server. See Update 0.1.6 for scripting additions and migration notes. Protocol 37 and older clients/servers are not compatible with this release.

Upcoming 0.1.7: built-in game audio — 11 client functions and a result event for game sound effects, music and localized dialogue, including world-positioned 3D audio. See Game audio and Update 0.1.7. These APIs are not included in public 0.1.6.

New in 0.1.6. Four new server-side functions: custom area notifications and player-owned rideable scavengers. Also includes mounted nameplate/recovery fixes, smoother ordinary doors and pickup performance/animation improvements. See the guides for remaining in-game validation.

Also included (since 0.1.5). NPC combat and scripting, walk/run pursuit, identity, skin colour, tattoos, player weapon modes and events. Also includes crouch synchronization, melee presentation and knockdown recovery improvements.

Also included (since 0.1.4). See MySQL connection recovery, Weapon control, Mouse capture, UpdateCameraPose, Map editor, World objects and 118 player animations for released tools and scripting APIs. Also see WebP images, os.time and remote event security.

Start here

Find the right entry point for your first resource.

• Lua API overview
• Complete function catalog
• Complete event and callback catalog
• Lua, resource and API limits
• Validated skin, monster, equipment, and gameplay keys
• NPC and monster navigation collision
• Client audio and synchronized 3D playback
• Built-in game audio (upcoming 0.1.7)
• Complete dialogue catalog (upcoming 0.1.7)
• Scripted camera and moving login backgrounds
• Map editor: controls, save and reopen (0.1.4)
• Load exported objects for players (0.1.4)
• Player animations: work, sitting, sleep and gestures (expanded in 0.1.4)
• Identity, skin color and tattoos
• Custom chapter title cards
• Custom area notifications (since 0.1.6)
• Rideable scavengers and ownership (since 0.1.6)
• Observer-specific labels and acquaintance presentation
• Resource lifecycle functions
• Lua examples
• Hosting a dedicated server
• Known issues and GPU crash workarounds
• 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

Connection recovery (0.1.4)

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

Browse functions and events by topic above. Each API page identifies its version and execution side. See Update 0.1.6 for the current release and Update 0.1.5 for the previous release. APIs marked experimental may change. Historical release notices remain on their dedicated reference pages.