Using Mod Manager (Recommended)#

1. Download the Mod Manager
2. Find ModAPI Diagnostic Tool in the Available mods list
3. Click Download to install automatically
4. Configure parameters in the GUI

Manual Installation#

1. Download the zip file above
2. Extract the modapi-diagnostic/ folder to your mods directory:
   • Windows: %APPDATA%\Godot\app_userdata\Tower Networking Inc\mods\
   • Linux: ~/.local/share/godot/app_userdata/Tower Networking Inc/mods/
3. Ensure luajit.elf is in the mods directory

ModAPI Diagnostic Tool v4.4#

Development tool for TNI game engine modding (0.10.11+).

FOR MOD DEVELOPERS AND EXTERNAL TOOL INTEGRATION

What’s New in v4.4#

• Debug console activation — the game ships with DebugLayer.enabled = false. This mod sets it to true on startup, making the ~ key open the debug console
• All commands in debug console — type command names directly (no parentheses)
• Netsh terminal documented — 23 built-in terminal routines mapped (see Netsh Terminal Reference)

What was new in v4.3#

• Debug console integration — all commands registered with DebugLayer.register_cmd()
• Removed sandbox probes — findings documented below in Sandbox API Reference

What was new in v4.0#

• Removed on_player_input entirely — eliminates the per-frame pcall/GC memory pressure that caused the memory leak in v3.x
• Added on_game_state_ready — the correct entrypoint for post-init diagnostics (world guaranteed valid)
• Added all missing callbacks: on_mod_load, on_mods_loaded, on_game_host_eod, on_location_spawned
• Lifecycle tracker — records exact callback order and timing for debugging init issues
• Expanded API coverage for game version 0.10.11: new PlayOptions fields, LogicControllerUser fields, all control modules, NETWORK_STORAGE device class, GameWorld methods
• New API getters tested: get_locations(), get_merchants(), get_game_version(), has_mods_reloaded()
• File write support — JSON export tries ModFileSystem before falling back to log output

Usage#

1. Place in mods/modapi-diagnostic/
2. Load the game — on_game_state_ready runs automatic diagnostics
3. Use console commands for interactive features
4. Check [DIAG] prefixed messages in the game console

Console Commands#

Open the debug console with ~ and type the command name (no parentheses needed):

dump_world_overview       -- Quick world summary (day, cash, counts)
inspect_locations         -- List all floors with user counts
dump_all_world_devices    -- List all devices with class/condition
reinspect_all_users       -- Re-inspect tracked users' network configs
export_to_json            -- Export full game state to JSON
run_api_test_suite        -- Test all API endpoints
export_test_results_json  -- Export test results as JSON
show_lifecycle_log        -- Show callback order and timing

Commands are also available as globals() for direct Lua calls.

Auto-triggers#

Lifecycle Callbacks#

All 16 known callbacks are registered. Use show_lifecycle_log() to see the exact order they fired:

[DIAG]    1. [0.0012s] on_mod_load -- mod binary/script loaded
[DIAG]    2. [0.0015s] on_mods_loaded -- all mods finished loading
[DIAG]    3. [0.0340s] on_engine_load
[DIAG]    4. [0.1200s] on_game_state_ready -- game fully initialized
[DIAG]    5. [0.1500s] on_location_spawned -- Floor 1: Lobby
[DIAG]    6. [0.1800s] on_device_spawned -- Switch-8 (NETWORK_SWITCH)
...

Complete Callback List#

JSON Export#

export_to_json() outputs a comprehensive game state snapshot. Tries writing to diagnostic-export.json via ModFileSystem, falls back to log output between === JSON GAME STATE START === / === JSON GAME STATE END === markers.

Data Sections#

API Test Suite#

run_api_test_suite() tests all documented API endpoints:

• ModApiV1: sanity, get_game_world, get_devices, get_users, get_locations, get_merchants, get_game_version, has_mods_reloaded
• Mod Global: mod_dir, mod_type, manifest, filesystem, config
• GameWorld: 17 properties + 8 methods (send_player_message, put_dns_entry, lookup_domain, etc.)
• DeviceUnit: 10 properties + methods
• User/LogicControllerUser: Base + extended fields (payment_calculation_method, csr, vsr, etc.)
• Locations: display_name, floor_num, is_datacenter, surge/outage immunity, etc.
• Network/Control Modules: networkctl, routectl, firewallctl, vlanctl, dhcpctl, filesysctl, packetctl
• Merchants: Properties + restock/submit_order methods
• Programs: release_name, cpu_load, install_size, etc.
• FileSystem: get_files_at, get_directories_at, open/read, mod_path_to_real
• GameWorld Methods: lookup_domain, get_loc_index (safe read-only calls)

Why No Keyboard Shortcuts?#

v3.x used on_player_input for Shift+R/D/J/Q shortcuts. This callback fires on every input event including mouse movement, and the C++ bridge crashes (bad_cast: Variant is not an Object for Variant of type 0 (Nil)) when pushing InputEvent userdata to the Lua stack. This happens before any Lua code executes, making it unfixable from Lua. Even without the crash, the per-frame pcall/GC overhead caused OOM in the ~1800-byte Lua arena.

v4.4 enables the game’s built-in debug console (DebugLayer) and registers commands with register_cmd(). Commands only run when explicitly invoked — zero per-frame overhead.

Sandbox API Reference#

Tested on game version 0.10.15. These findings document what the RISC-V mod sandbox permits.

BLOCKED — Will Not Work#

WORKS — Safe to Use#

Command Registration Pattern#

The recommended pattern for exposing mod commands:

-- 1. Define as global (fallback for direct Lua calls)
function my_command()
    print("Hello from my mod!")
end

-- 2. Enable debug console and register in on_game_state_ready
function on_game_state_ready()
    local world = ModApiV1.get_game_world()
    if not world then return end

    local ok, dbg = pcall(function()
        return world.get_node("/root/DebugLayer")
    end)
    if not ok or not dbg then
        print("[my-mod] DebugLayer not found")
        return
    end

    -- Enable the debug console (disabled by default)
    pcall(function() dbg.enabled = true end)
    pcall(function() dbg.visible = true end)

    pcall(function() dbg.register_cmd("my_command", my_command) end)
end

Players can then open the debug console with ~ and type my_command.

Netsh Terminal Reference#

The in-game “netsh” terminal (the pseudo gameplay terminal on the player’s monitor) is separate from the debug console. It is a NetShell (VBoxContainer) found via world.mobile_os_cvl.find_child("*Shell*").

Built-in Terminal Routines (23)#

Netsh Injection — Not Currently Possible#

Custom commands cannot be injected into the netsh terminal because:

• TerminalRoutine subclasses are not registered in create_node() — they cannot be instantiated from Lua
• The terminal_routines array can be read but appending requires a valid TerminalRoutine instance
• AliasRoutine.alias_expand() only does string→string substitution between existing commands
• The netsh reports unknown routine for any unregistered command name

Use the debug console (~) for mod commands instead.

Device Hardware Classes (0.10.11)#

This is a developer tool for mod creators and external tool integrations. No gameplay impact. Ideal for:

• Mod developers learning the API
• Building REST API bridges
• Terraform/OpenTofu provider development
• Game state analysis and automation

Release URLs:

• Latest Release
• Direct Download