|
|
| Line 1: |
Line 1: |
| __NOTOC__
| | <strong>MediaWiki has been installed.</strong> |
|
| |
|
| <div style="background:#111611; color:#eee7d5; border:1px solid #8f7338; border-top:4px solid #c6a251; padding:1.6rem 1.8rem; margin-bottom:1.25rem;">
| | Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software. |
| <div style="color:#c6a251; font-size:0.78rem; font-weight:bold; letter-spacing:0.08em; text-transform:uppercase;">Gothic 1 Remake Multiplayer</div>
| |
| <div style="font-size:2.25rem; font-weight:bold; line-height:1.1; margin:0.25rem 0 0.55rem;">G1R:MP Scripting Wiki</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>
| |
|
| |
|
| <div style="display:flex; flex-wrap:wrap; gap:1rem; margin-bottom:1rem;">
| | == Getting started == |
| <div style="flex:1 1 22rem; border:1px solid #c9c2b2; border-left:4px solid #b28a3d; padding:1rem 1.15rem; background:#faf9f5;">
| | * [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list] |
| <div style="font-size:1.35rem; font-weight:bold; margin-bottom:0.45rem;">Start here</div>
| | * [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ] |
| <div style="color:#555; margin-bottom:0.6rem;">Find the right entry point for your first resource.</div>
| | * [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list] |
| <ul style="margin:0.35rem 0 0 1.25rem; line-height:1.75;">
| | * [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language] |
| <li>[[:Category:Lua API|Lua API overview]]</li>
| | * [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki] |
| <li>[[:Category:Lua Functions|Complete function catalog]]</li>
| |
| <li>[[:Category:Resource Functions|Resource lifecycle functions]]</li>
| |
| <li>[[:Category:Lua Examples|Lua examples]]</li>
| |
| <li>[[:Category:Experimental Lua API|Experimental API status]]</li>
| |
| </ul>
| |
| </div>
| |
| | |
| <div style="flex:1 1 22rem; border:1px solid #c9c2b2; border-left:4px solid #6f8461; padding:1rem 1.15rem; background:#faf9f5;">
| |
| <div style="font-size:1.35rem; font-weight:bold; margin-bottom:0.45rem;">Reference by execution side</div>
| |
| <div style="color:#555; margin-bottom:0.6rem;">Check where a function is available before using it.</div>
| |
| <ul style="margin:0.35rem 0 0 1.25rem; line-height:1.75;">
| |
| <li>[[:Category:Server Functions|Server-side functions]]</li>
| |
| <li>[[:Category:Client Functions|Client-side functions]]</li>
| |
| <li>[[:Category:Shared Functions|Shared functions]]</li>
| |
| <li>[[:Category:Event Functions|Event functions]]</li>
| |
| <li>[[:Category:Network Functions|Network functions]]</li>
| |
| </ul>
| |
| </div>
| |
| </div>
| |
| | |
| <div style="display:flex; flex-wrap:wrap; gap:1rem; margin-bottom:1rem;">
| |
| <div style="flex:1 1 22rem; border:1px solid #c9c2b2; padding:1rem 1.15rem; background:#fff;">
| |
| <div style="font-size:1.25rem; font-weight:bold; border-bottom:1px solid #ded8ca; padding-bottom:0.45rem; margin-bottom:0.6rem;">Gameplay</div>
| |
| <div style="display:grid; grid-template-columns:repeat(auto-fit,minmax(10rem,1fr)); gap:0.4rem 1rem; line-height:1.65;">
| |
| <div>[[:Category:Player Functions|Players]]</div>
| |
| <div>[[:Category:Spatial Functions|Position and spawn]]</div>
| |
| <div>[[:Category:Progression Functions|Progression]]</div>
| |
| <div>[[:Category:Inventory Functions|Inventory]]</div>
| |
| <div>[[:Category:Equipment Functions|Equipment]]</div>
| |
| <div>[[:Category:Magic Functions|Magic]]</div>
| |
| <div>[[:Category:Life State Functions|Health and life state]]</div>
| |
| <div>[[:Category:World Functions|World time and weather]]</div>
| |
| </div>
| |
| </div>
| |
| | |
| <div style="flex:1 1 22rem; border:1px solid #c9c2b2; padding:1rem 1.15rem; background:#fff;">
| |
| <div style="font-size:1.25rem; font-weight:bold; border-bottom:1px solid #ded8ca; padding-bottom:0.45rem; margin-bottom:0.6rem;">Scripting systems</div>
| |
| <div style="display:grid; grid-template-columns:repeat(auto-fit,minmax(10rem,1fr)); gap:0.4rem 1rem; line-height:1.65;">
| |
| <div>[[:Category:GUI Functions|RmlUi and GUI]]</div>
| |
| <div>[[:Category:Database Functions|Database]]</div>
| |
| <div>[[:Category:Timer Functions|Timers]]</div>
| |
| <div>[[:Category:Command Functions|Commands]]</div>
| |
| <div>[[:Category:Chat Functions|Chat]]</div>
| |
| <div>[[:Category:Animation Functions|Animations]]</div>
| |
| <div>[[:Category:Camera Functions|Camera]]</div>
| |
| </div>
| |
| </div>
| |
| </div>
| |
| | |
| == Your first server script ==
| |
| | |
| The following example welcomes a joining player and places them at an authoritative spawn point:
| |
| | |
| <syntaxhighlight lang="lua" line>
| |
| 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)
| |
| </syntaxhighlight>
| |
| | |
| See [[AddEventHandler|addEventHandler]], [[SetPlayerName|setPlayerName]], [[SpawnPlayer|spawnPlayer]], and [[OutputChatBox|outputChatBox]] for parameter details and additional examples.
| |
| | |
| <div style="display:flex; flex-wrap:wrap; gap:1rem; margin-top:1.25rem;">
| |
| <div style="flex:1 1 22rem; border-top:3px solid #b28a3d; background:#f5f2e9; padding:1rem 1.15rem;">
| |
| <div style="font-size:1.2rem; font-weight:bold; margin-bottom:0.4rem;">Community</div>
| |
| <ul style="margin:0.35rem 0 0 1.25rem; line-height:1.7;">
| |
| <li>[https://g1r-mp.com/ G1R:MP website]</li>
| |
| <li>[https://g1r-mp.com/forum/ Community forum]</li>
| |
| <li>[https://g1r-mp.com/forum/member.php?action=profile&uid=1 Project lead: QCherry]</li>
| |
| </ul>
| |
| </div>
| |
| | |
| <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="line-height:1.6;">The reference currently contains '''134 documented Lua functions'''. 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>
| |
| | |
| [[Category:Lua API]]
| |