Skip to main content

gui_config

Typewriter Web panel: click Add Page, then use Search bar or + to create the entry with its exact identifier.

This entry configures the global behavior of the GUI extension. It does not create a menu; it prepares the engine and web editor.

Fields

Exact fieldTypeVerified defaultUse
idStringdefaultIdentifier for this configuration.
debugBooleanfalseEnables detailed logs for the GUI engine, internal commands, scrolling, and animations.
editorEnabledBooleanfalseEnables the GUI web editor.
hideVanillaItemStatsBooleantrueHides vanilla statistics automatically added to GUI items.

Enable the web editor

  1. In the gui_config entry, enable editorEnabled.
  2. Restart or reload according to your server procedure.
  3. Open the URL displayed by the runtime with the generated token.
  4. Check that HTTP/WebSocket port 8082 is reachable from your workstation.

The runtime also reads plugins/Typewriter/gui_editor.yml. The editor uses the /ws WebSocket path on the same port 8082. The token is retained by default; auth-token: "disabled" disables protection and must remain limited to an isolated environment.

Do not expose by default

For a remote server, configure the bind address, firewall, allowed origins, and TLS. Historical code comments mention 9093, but the verified runtime implementation does not use this port as a separate channel.

Common error

If the editor does not open, check editorEnabled, plugins/Typewriter/gui_editor.yml, the network bind, the token, and port 8082. debug: true helps diagnose loading, but does not replace network configuration.