diff --git a/bootstrapper-manual.html b/bootstrapper-manual.html index 369ba23..0d62dc0 100644 --- a/bootstrapper-manual.html +++ b/bootstrapper-manual.html @@ -75,9 +75,9 @@
While the main feature of the bootstrapper (wtsapi32.dll, dwmapi.dll, or version.dll) is to use a custom server with the game, it has other features as well.
+While the main feature of the Bootstrapper (wtsapi32.dll, dwmapi.dll, or version.dll) is to use a custom server with the game, it has other features as well.
The bootstrapper's configuration is in OpenWF/Client Config.json relative to your game folder. It has the following fields:
The Bootstrapper's configuration is in OpenWF/Client Config.json relative to your game folder. It has the following fields:
fallback_language — If not empty, this language will be used when Warframe.x64.exe is invoked without a language command line argument.fallback_languageVO — If not empty, this voiceover language will be used when Warframe.x64.exe is invoked without a languageVO command line argument.While the game is running, you can visit http://localhost:6155/ to modify some of the above options, access additional features like teleportation, and use scripts.
This web interface uses the game's language or ?lang= query parameter to check for translations. The builtin translations are mirrored from https://onlyg.it/OpenWF/Translations. You can provide a OpenWF/dict.cat.txt file to provide a custom work-in-progress translation.
Developers can also use the HTTP interface to interact with the bootstrapper. In addition to commands (documented below), the following routes are available: /ping, /save_all_metadata, /write_all_metadata_reads_to_console, /write_all_metadata_reads_to_ee_log, /write_patched_metadata_reads_to_console, /write_patched_metadata_reads_to_ee_log, /pause_always_stops_time, /server_host, /status, /toggle_console, /scripts, /start_script, /start_script_inline, /autostart_scripts, /add_autostart_script, /remove_autostart_script, /apply_hotfix, /version, /game_version, /check_label_replacements, /memory, /get_effective_metadata
Developers can also use the HTTP interface to interact with the Bootstrapper. In addition to commands (documented below), the following routes are available: /ping, /save_all_metadata, /write_all_metadata_reads_to_console, /write_all_metadata_reads_to_ee_log, /write_patched_metadata_reads_to_console, /write_patched_metadata_reads_to_ee_log, /pause_always_stops_time, /server_host, /status, /toggle_console, /scripts, /start_script, /start_script_inline, /autostart_scripts, /add_autostart_script, /remove_autostart_script, /apply_hotfix, /version, /game_version, /check_label_replacements, /memory, /get_effective_metadata
The bootstrapper adds the owfServerHost command line argument, which can be used to override the server_host in the config.
The Bootstrapper adds the owfServerHost command line argument, which can be used to override the server_host in the config.
When connecting to a server, the bootstrapper requests /custom/tunables.json. The resulting JSON object may provide the following fields:
When connecting to a server, the Bootstrapper requests /custom/tunables.json. The resulting JSON object may provide the following fields:
token — if given, this string will be provided as a query parameter in the login request to indicate acknowledgement of the tunablesprohibit_skip_mission_start_timer — if true, prohibits skip_mission_start_timerprohibit_teleport — if true, prohibits teleportprohibit_scripts — if true, prohibits the execution of user-defined scriptsTo aid in troubleshooting, the bootstrapper assumes that a compatible server responds to this request with status code 200 and a valid JSON object, otherwise showing a warning popup.
+To aid in troubleshooting, the Bootstrapper assumes that a compatible server responds to this request with status code 200 and a valid JSON object, otherwise showing a warning popup.
buildLabel to indicate the client's buildLabel.If multiple patches affect the same absolute path, they are combined.
The bootstrapper handles the client's content requests by consulting the OpenWF/Content/ folder, forwarding the request to the configured server in case a file is not found.
At minimum, the client will request /0/H.Cache.bin!D_---------------------w. The bootstrapper has 3 modes for managing this file:
The Bootstrapper handles the client's content requests by consulting the OpenWF/Content/ folder, forwarding the request to the configured server in case a file is not found.
At minimum, the client will request /0/H.Cache.bin!D_---------------------w. The Bootstrapper has 3 modes for managing this file:
B.Cache.Windows.bin and H.Cache.bin) will be created to ensure your content is loaded. Otherwise,OpenWF/Content/0/UNMANAGED exists, it is assumed that OpenWF/Content/0/H.Cache.bin!D_---------------------w is correctly in place and no attempts to correct it will be made. Otherwise,OpenWF/Content/0/H.Cache.bin!D_---------------------w file that should require no extra content requests except for undoing content replacements.OpenWF/Content/0/H.Cache.bin!D_---------------------w file that should require no extra content requests except for undoing content replacements.After login, the bootstrapper will attempt to establish a WebSocket connection with ws://server_host:http_port/custom/ws. If the WebSocket upgrade succeeds, the bootstrapper sends {"auth_game":{"accountId":...,"nonce":...}}. With this connection in place, the server can send {"sync_inventory":true} to cause the client to resync from inventory.php or {"tunables":{...}} to send updated tunables.
After login, the Bootstrapper will attempt to establish a WebSocket connection with ws://server_host:http_port/custom/ws. If the WebSocket upgrade succeeds, the Bootstrapper sends {"auth_game":{"accountId":...,"nonce":...}}. With this connection in place, the server can send {"sync_inventory":true} to cause the client to resync from inventory.php or {"tunables":{...}} to send updated tunables.
The command API is a versatile way for developers to interact with the bootstrapper. Commands are available via HTTP, WebSocket, and the scripting API. For example, to enable skip_mission_start_timer, one can use HTTP with /skip_mission_start_timer?true, WebSocket with send("skip_mission_start_timer?true") or scripting with owf_command("skip_mission_start_timer?true").
The command API is a versatile way for developers to interact with the Bootstrapper. Commands are available via HTTP, WebSocket, and the scripting API. For example, to enable skip_mission_start_timer, one can use HTTP with /skip_mission_start_timer?true, WebSocket with send("skip_mission_start_timer?true") or scripting with owf_command("skip_mission_start_timer?true").
The following commands are available: logout, save_config, reload_hotkeys, reload_label_replacements, reload_metadata_patches, available_scripts, running_scripts, autostart_scripts, script_log, clear_script_log, stop_script, high_damage_numbers_patch, skip_mission_start_timer, simulacrum_blacklisted, simulacrum_whitelisted, alternative_loading, ee_log_in_console, dont_resolve_labels, fov_override, freecam, lockcam, gamecam, teleport, enable_pause_always_stops_time, disable_pause_always_stops_time, request_bgscript_broadcasts, download_latest_hotfix, check_for_updates
I hope this document was useful. If you have any feature requests or bug reports regarding the bootstrapper, feel free to submit them at https://onlyg.it/OpenWF/Bootstrapper/issues.
+I hope this document was useful. If you have any feature requests or bug reports regarding the Bootstrapper, feel free to submit them at https://onlyg.it/OpenWF/Bootstrapper/issues.