Main Page: Difference between revisions
Jump to navigation
Jump to search
Link dedicated server hosting requirements |
Announce Lua APIs planned for G1R:MP update 0.1.2 |
||
| Line 6: | Line 6: | ||
<div style="max-width:58rem; color:#cfc8b8; font-size:1.02rem; line-height:1.55;">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.</div> | <div style="max-width:58rem; color:#cfc8b8; font-size:1.02rem; line-height:1.55;">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.</div> | ||
<div style="margin-top:1rem; color:#e1c36d; font-size:0.9rem;">Lua 5.1 • server and client resources • authoritative gameplay • RmlUi</div> | <div style="margin-top:1rem; color:#e1c36d; font-size:0.9rem;">Lua 5.1 • server and client resources • authoritative gameplay • RmlUi</div> | ||
</div> | |||
<div style="background:#0b0b0b; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#f1f1f1; padding:0.95rem 1.1rem; margin:0 0 1.25rem;"> | |||
<div style="color:#ff5a5a; font-size:1.05rem; font-weight:bold; letter-spacing:0.04em;">COMING IN UPDATE 0.1.2</div> | |||
<div style="color:#f1f1f1; margin-top:0.35rem; line-height:1.55;">Advance documentation is now available for eight upcoming server functions. These APIs are not yet available in the current public release.</div> | |||
<div style="margin-top:0.55rem; line-height:1.75;">[[completePlayerConsumableFinalize]] • [[completePlayerConsumableUse]] • [[getPlayerAccountBindingSerial]] • [[getPlayerConsumableNames]] • [[setMonsterMaxHealth]] • [[setNpcIdVisible]] • [[spawnItem]] • [[walkMonsterTo]]</div> | |||
<div style="color:#f1f1f1; margin-top:0.35rem;">Also documented: [[onNpcIdVisibilityChange]] and the [[World item catalog]].</div> | |||
</div> | </div> | ||
| Line 98: | Line 105: | ||
<div style="flex:1 1 22rem; border-top:3px solid #6f8461; background:#f5f2e9; padding:1rem 1.15rem;"> | <div style="flex:1 1 22rem; border-top:3px solid #6f8461; background:#f5f2e9; padding:1rem 1.15rem;"> | ||
<div style="font-size:1.2rem; font-weight:bold; margin-bottom:0.4rem;">Documentation status</div> | <div style="font-size:1.2rem; font-weight:bold; margin-bottom:0.4rem;">Documentation status</div> | ||
<div style="line-height:1.6;">The reference | <div style="line-height:1.6;">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 [[:Category:Experimental Lua API|experimental]] have validated contracts but may still change while the multiplayer runtime is under active development.</div> | ||
</div> | </div> | ||
</div> | </div> | ||
[[Category:Lua API]] | [[Category:Lua API]] | ||
Revision as of 17:33, 2 September 2026
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.
Reference by execution side
Check where a function is available before using it.
Gameplay
Scripting systems
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.
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.