Update bootstrapper manual for 0.10.4

This commit is contained in:
Sainan 2025-03-11 09:06:30 +01:00
parent d1db21cfdc
commit a1468f647b

View File

@ -85,7 +85,7 @@
<li><code>server_host</code> — The hostname or IP address to redirect game traffic to. This should match <code>myAddress</code> in SpaceNinjaServer.</li>
<li><code>http_port</code> — The port to use for HTTP traffic. This should match <code>httpPort</code> in SpaceNinjaServer.</li>
<li><code>https_port</code> — The port to use for HTTPS traffic. This should match <code>httpsPort</code> in SpaceNinjaServer.</li>
<li><code>autologin</code></li>
<li><code>autologin</code> — Uses the provided credentials to automatically login on startup. If another instance is logged in on the same account, it will be forcefully logged out.</li>
<li><code>autologin_email</code></li>
<li><code>autologin_password</code> — The whirlpool hash of the password to use for autologin. You can simply enter your password and it will automatically be hashed and overwritten.</li>
@ -109,7 +109,7 @@
<li><code>write_patches_metadata_reads_to_ee_log</code> — If true, write patched metadata reads to EE.log. May degrade performance.</li>
</ul>
<h2>HTTP Interface</h2>
<p>While the game is running, the you can visit <a href="http://localhost:61558/" target="_blank">http://localhost:61558/</a> to modify some of the above options, access additional features like teleportation, and use scripts.</p>
<p>While the game is running, the you can visit <a href="http://localhost:6155/" target="_blank">http://localhost:6155/</a> to modify some of the above options, access additional features like teleportation, and use scripts.</p>
<h2>Command Line Arguments</h2>
<p>The bootstrapper adds the <code>owfServerHost</code> command line argument, which can be used to override the <code>server_host</code> in the config.</p>
<h2>Pre-Login</h2>
@ -124,11 +124,12 @@
<li><code>prohibit_scripts</code></li>
</ul>
<p>The presence of a field disables the respective feature.</p>
<h2>HTTP Traffic Deviations</h2>
<h2>Traffic Deviations</h2>
<ul>
<li>login.php & worldState.php requests have the extra query parameter <code>buildLabel</code> to indicate the client's buildLabel.</li>
<li>login.php requests also have an extra <code>clientMod</code> parameter indicating the Bootstrapper's name and version. If Metadata Patches are in use, <code>metadataPatchesInUse=1</code> is added as well.</li>
<li>inventory.php & missionInventoryUpdate.php requests have the extra query parameter <code>xpBasedLevelCapDisabled</code> to indicate that the client has been patched to accept any PlayerLevel and doesn't need XPInfo to match.</li>
<li>The IRC <code>USER</code> message is adjusted to contain <code>nonce=...</code> in the 'realname' field.</li>
</ul>
<h2>Metadata Patches</h2>
<p>Metadata Patches are loaded from <code>OpenWF/Metadata Patches.txt</code>, although you can also create a <code>OpenWF/Metadata Patches/</code> folder and any text file inside of that will be loaded as well.</p>