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

COMING IN UPDATE 0.1.2

Advance documentation is now available for eight upcoming server functions. These APIs are not yet available in the current public release.

completePlayerConsumableFinalize • completePlayerConsumableUse • getPlayerAccountBindingSerial • getPlayerConsumableNames • setMonsterMaxHealth • setNpcIdVisible • spawnItem • walkMonsterTo

Also documented: onNpcIdVisibilityChange and the World item catalog.

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
• 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
• 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

Interactions

Scripting systems

RmlUi and GUI

Database

Known MySQL/MariaDB issue

Timers

Commands

Chat

Animations

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 236 Lua functions in the current public release plus 8 functions documented in advance for update 0.1.2. It also contains 80 current public events plus 1 event planned for update 0.1.2. See Lua API catalogs for validated skin, monster, equipment, progression, and gameplay keys. APIs marked experimental have validated contracts but may still change while the multiplayer runtime is under active development.