Skip to content

Add TCP console socket support, Windows helper scripts and documentation updates#19

Open
boscv wants to merge 25 commits into
codex/find-remote-control-plugin-for-korefrom
codex/troubleshoot-openkore-remote-connection-issue
Open

Add TCP console socket support, Windows helper scripts and documentation updates#19
boscv wants to merge 25 commits into
codex/find-remote-control-plugin-for-korefrom
codex/troubleshoot-openkore-remote-connection-issue

Conversation

@boscv
Copy link
Copy Markdown
Owner

@boscv boscv commented Apr 15, 2026

Motivation

  • Enable the gateway to talk to OpenKore over a TCP console endpoint on Windows and other environments where Unix sockets are not available, and to document/automate the recommended ways to start OpenKore+gateway on Windows.
  • Make startup behavior more robust by checking TCP endpoints before launching the gateway and avoid removing Unix socket files when running in TCP mode.

Description

  • src/Interface/Socket.pm: added IO::Socket::INET and Errno usage, support for OPENKORE_SOCKET_TCP_HOST/OPENKORE_SOCKET_TCP_PORT environment variables, a use_tcp flag, endpoint_desc, and separate handling for TCP vs Unix socket listen semantics including safer PID/socket file handling and informational output.
  • tools/start-gateway.ps1: added Test-TcpEndpoint helper and a pre-launch TCP reachability check that issues warnings if the configured OpenKore TCP console endpoint is not reachable, and improved logging/messages after Start-Process and healthcheck.
  • tools/start-openkore-socket-tcp.ps1: new script to start OpenKore with --interface=Socket and export OPENKORE_SOCKET_TCP_HOST/OPENKORE_SOCKET_TCP_PORT, wait for the TCP console to open, and optionally start the gateway with the right parameters.
  • Documentation updates (docs/guia-acesso-remoto-pt-br.md and docs/guia-acesso-remoto-windows-nativo.md): clarified that the gateway requires the OpenKore console protocol (set active/input), explained that XKore_port is not necessarily compatible, added Windows-specific instructions and examples for enabling the socket TCP endpoint and validating connectivity.

Testing

  • No automated tests were run as part of this change.

Codex Task

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 46d7f1fe82

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread tools/start-gateway.ps1 Outdated
Comment thread tools/start-openkore-socket-tcp.ps1
boscv added 24 commits April 15, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant