Main Page: Difference between revisions

From Wiki G1R-MP G1 Remake Multiplayer
Jump to navigation Jump to search
← Older edit

QCherry (talk | contribs)

3 user groups
1,197 edits
Document skin color and tattoos available from 0.1.3; identity/armor improvements
Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release
 
(17 intermediate revisions by the same user not shown)
Line 8: Line 8:
</div>
</div>


<div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;">
<div style="border:1px solid #b28a3d; border-left:4px solid #b28a3d; background:#faf9f5; padding:0.9rem 1rem; margin:0 0 1.2rem;">
<div style="color:#111; font-size:1.05rem; font-weight:bold; letter-spacing:0.04em;">PLAYER CUSTOMIZATION — AVAILABLE FROM UPDATE 0.1.3</div>
'''Current public release: G1R:MP 0.1.6 / BUILD174 / Protocol 38.''' Windows client and Windows/Linux dedicated server downloads are available on the [https://g1r-mp.com/download/ 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.
<div style="color:#111; margin-top:0.35rem; line-height:1.55;">'''7 new server-side functions''' provide independent skin-color and tattoo overrides. Existing identity selection has improved head and armor compatibility from update 0.1.3. See [[Player customization]] for examples and reset behavior, and [[Player tattoo catalog]] for all 12 keys.</div>
<div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Skin color:</strong> [[setPlayerSkinColor]] &bull; [[getPlayerSkinColor]] &bull; [[resetPlayerSkinColor]]</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Tattoos:</strong> [[setPlayerTattoo]] &bull; [[getPlayerTattoo]] &bull; [[resetPlayerTattoo]] &bull; [[getPlayerTattooNames]]</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Improved existing API:</strong> [[setPlayerIdentity]] keeps the game-owned body and equipped armor. These are cosmetic controls, not a full NPC body/outfit replacement.</div>
</div>
</div>


<div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;">
<!-- g1r-upcoming017-game-audio:start -->
<div style="color:#111; font-size:1.05rem; font-weight:bold; letter-spacing:0.04em;">SCRIPTED CAMERA — AVAILABLE FROM UPDATE 0.1.3</div>
<div style="border:1px solid #b89a50; padding:0.85rem 1rem; margin:1rem 0;">
<div style="color:#111; margin-top:0.35rem; line-height:1.55;">'''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.</div>
'''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.
<div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Client and server (10):</strong> [[setCameraPos]] &bull; [[setCameraRot]] &bull; [[setCameraLookAt]] &bull; [[setCameraFOV]] &bull; [[setCameraPose]] &bull; [[moveCameraTo]] &bull; [[playCameraPath]] &bull; [[orbitCamera]] &bull; [[stopCameraMovement]] &bull; [[resetCameraPos]]</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Client read-back (5):</strong> [[getCameraPos]] &bull; [[getCameraRot]] &bull; [[getCameraFOV]] &bull; [[getCameraState]] &bull; [[requestCameraState]]</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Client events (2):</strong> [[onClientCameraCommandResult]] &bull; [[onClientCameraReset]]. Client commands use asynchronous acknowledgements; server calls return only a queued boolean.</div>
</div>
</div>
<!-- g1r-upcoming017-game-audio:end -->


<div style="background:#fff8f8; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111; padding:0.95rem 1.1rem; margin:0 0 1.25rem;">
<!-- upcoming016:start -->
<div style="color:#111; font-size:1.05rem; font-weight:bold; letter-spacing:0.04em;">AVAILABLE AND IMPROVED FROM UPDATE 0.1.2</div>
<div style="border:1px solid #6f8461; background:#f5f8f2; padding:0.9rem 1rem; margin-bottom:1.2rem;">
<div style="color:#111; margin-top:0.35rem; line-height:1.55;">The following '''40 Lua functions''' &mdash; 29 server-side and 11 client-side &mdash; 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.</div>
'''New in [[Update 0.1.6|0.1.6]].''' Four new server-side functions: [[Area notifications|custom area notifications]] and [[Mounts|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.
</div>
<!-- upcoming016:end -->


<div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Accounts and consumables (4):</strong> [[completePlayerConsumableFinalize]] &bull; [[completePlayerConsumableUse]] &bull; [[getPlayerAccountBindingSerial]] &bull; [[getPlayerConsumableNames]]</div>
<div style="border:1px solid #6f8461; background:#f5f8f2; padding:0.9rem 1rem; margin-bottom:1.2rem;">
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>World items (1):</strong> [[spawnItem]] &mdash; see also the [[World item catalog]].</div>
'''Also included (since [[Update 0.1.5|0.1.5]]).''' [[NPC scripting|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.
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Monster identity, health, and combat (5):</strong> [[setMonsterName]] &bull; [[setMonsterIdVisible]] &bull; [[setMonsterMaxHealth]] &bull; [[getMonsterAttackDamage]] &bull; [[setMonsterAttackDamage]]</div>
</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Monster navigation (6):</strong> [[setMonsterNavigationMode]] &bull; [[setMonsterNavigationCollisionMode]] &bull; [[setMonsterMoveGoal]] &bull; [[stopMonsterMovement]] &bull; [[testMonsterMove]] &bull; [[walkMonsterTo]]</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>NPC identity and navigation (7):</strong> [[setNpcIdVisible]] &bull; [[setNpcObstacleBehavior]] &bull; [[setNpcNavigationMode]] &bull; [[setNpcNavigationCollisionMode]] &bull; [[setNpcMoveGoal]] &bull; [[stopNpcMovement]] &bull; [[testNpcMove]]</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Custom navigation blockers (6):</strong> [[createAiNavigationBlocker]] &bull; [[updateAiNavigationBlocker]] &bull; [[setAiNavigationBlockerEnabled]] &bull; [[destroyAiNavigationBlocker]] &bull; [[getAiNavigationBlockerData]] &bull; [[getAiNavigationBlockers]] &mdash; see [[NPC and monster navigation collision]].</div>
<div style="color:#111; margin-top:0.35rem; line-height:1.65;"><strong>Client audio (11):</strong> [[playSound]] &bull; [[playSound3D]] &bull; [[stopSound]] &bull; [[setSoundVolume]] &bull; [[getSoundVolume]] &bull; [[setSoundPaused]] &bull; [[isSoundPaused]] &bull; [[isSoundPlaying]] &bull; [[setSoundLooped]] &bull; [[setSound3DPosition]] &bull; [[setSound3DMinMaxDistance]] &mdash; see [[Client audio]].</div>


<div style="color:#111; margin-top:0.65rem; line-height:1.65;"><strong>Events available from 0.1.2 (8):</strong> [[onNpcIdVisibilityChange]] &bull; [[onMonsterNameChange]] &bull; [[onMonsterIdVisibilityChange]] &bull; [[onMonsterMoveBlocked]] &bull; [[onMonsterMoveComplete]] &bull; [[onNpcMoveBlocked]] &bull; [[onNpcMoveComplete]] &bull; [[onWorldItemDrop]]. Existing [[onPlayerJoin]], [[onPlayerQuit]], [[onWorldItemPickup]], and [[onWorldItemSpawn]] contracts are also improved from 0.1.2.</div>
<div style="border:1px solid #6f8461; background:#f5f8f2; padding:0.9rem 1rem; margin-bottom:1.2rem;">
'''Also included (since [[Update 0.1.4|0.1.4]]).''' See [[MySQL connection recovery]], [[Weapon control]], [[Mouse capture]], [[UpdateCameraPose]], [[Map editor]], [[World objects]] and [[Player animation catalog|118 player animations]] for released tools and scripting APIs. Also see [[RmlUi images|WebP images]], [[os.time]] and [[getEventClient|remote event security]].
</div>
</div>


Line 47: Line 40:
<li>[[:Category:Lua Functions|Complete function catalog]]</li>
<li>[[:Category:Lua Functions|Complete function catalog]]</li>
<li>[[Lua events|Complete event and callback catalog]]</li>
<li>[[Lua events|Complete event and callback catalog]]</li>
<li>[[Scripting limits|Lua, resource and API limits]]</li>
<li>[[Lua API catalogs|Validated skin, monster, equipment, and gameplay keys]]</li>
<li>[[Lua API catalogs|Validated skin, monster, equipment, and gameplay keys]]</li>
<li>[[NPC and monster navigation collision|NPC and monster navigation collision]]</li>
<li>[[NPC and monster navigation collision|NPC and monster navigation collision]]</li>
<li>[[Client audio|Client audio and synchronized 3D playback]]</li>
<li>[[Client audio|Client audio and synchronized 3D playback]]</li>
<li>[[Scripted camera|Scripted camera and moving login backgrounds (0.1.3)]]</li>
<li>[[Game audio|Built-in game audio (upcoming 0.1.7)]]</li>
<li>[[Game dialogue catalog|Complete dialogue catalog (upcoming 0.1.7)]]</li>
<li>[[Scripted camera|Scripted camera and moving login backgrounds]]</li>
<li>[[Map editor|Map editor: controls, save and reopen (0.1.4)]]</li>
<li>[[Map scene deployment|Load exported objects for players (0.1.4)]]</li>
<li>[[Player animation catalog|Player animations: work, sitting, sleep and gestures (expanded in 0.1.4)]]</li>
<li>[[Player customization|Identity, skin color and tattoos]]</li>
<li>[[Chapter screens|Custom chapter title cards]]</li>
<li>[[Area notifications|Custom area notifications (since 0.1.6)]]</li>
<li>[[Mounts|Rideable scavengers and ownership (since 0.1.6)]]</li>
<li>[[Observer nameplates|Observer-specific labels and acquaintance presentation]]</li>
<li>[[:Category:Resource Functions|Resource lifecycle functions]]</li>
<li>[[:Category:Resource Functions|Resource lifecycle functions]]</li>
<li>[[:Category:Lua Examples|Lua examples]]</li>
<li>[[:Category:Lua Examples|Lua examples]]</li>
<li>[[Hosting a G1R:MP dedicated server|Hosting a dedicated server]]</li>
<li>[[Hosting a G1R:MP dedicated server|Hosting a dedicated server]]</li>
<li>[[Known issues|Known issues and GPU crash workarounds]]</li>
<li>[[:Category:Experimental Lua API|Experimental API status]]</li>
<li>[[:Category:Experimental Lua API|Experimental API status]]</li>
</ul>
</ul>
Line 97: Line 102:
<div>[[:Category:GUI Functions|RmlUi and GUI]]</div>
<div>[[:Category:GUI Functions|RmlUi and GUI]]</div>
<div>[[:Category:Database Functions|Database]]</div>
<div>[[:Category:Database Functions|Database]]</div>
<div>[[Known issue: MySQL error 2006 (Server has gone away)|Known MySQL/MariaDB issue]]</div>
<div>[[MySQL connection recovery|Connection recovery (0.1.4)]]</div>
<div>[[:Category:Timer Functions|Timers]]</div>
<div>[[:Category:Timer Functions|Timers]]</div>
<div>[[:Category:Command Functions|Commands]]</div>
<div>[[:Category:Command Functions|Commands]]</div>
Line 135: Line 140:
<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 contains '''298 Lua functions''' and '''94 events''', including '''7 skin-color/tattoo functions, 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 [[Player customization]] for identity, color and tattoos, [[Lua API catalogs]] for validated gameplay keys, and [[Scripted camera]] for camera state and lifecycle rules. APIs marked [[:Category:Experimental Lua API|experimental]] may still change while the multiplayer runtime is under active development.</div>
<div style="line-height:1.6;">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 [[:Category:Experimental Lua API|experimental]] may change. Historical release notices remain on their dedicated reference pages.</div>
</div>
</div>
</div>
</div>


[[Category:Lua API]]
[[Category:Lua API]]

Latest revision as of 10:21, 1 October 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

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.

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
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.
Retrieved from "https://g1r-mp.com/wiki/index.php?title=Main_Page&oldid=1198"