SHINRIYO Remote Server is a free MIT-licensed addon for testing a running Godot game through a compatible remote client. The game runs on your development computer; the client displays streamed JPEG frames and sends input back to the game.

Features include touch, mouse and keyboard input, sensor forwarding, configurable frame rate, JPEG quality and image scale, optional connection passwords, and Bonjour discovery for Mac servers and iPhone clients.

Requirements and installation

Tested with Godot 4.7.2. Other versions have not been verified.

1. Install the addon so that addons/godot_remote/plugin.cfg is inside your game project.
2. Open Project > Project Settings > Plugins and enable Godot Remote 4.
3. Run or restart your game.
4. Open the compatible client on the same trusted local network, select the running game or enter its LAN address, and connect.

The server starts automatically in debug builds. The default TCP port is 22766. Use different ports for simultaneous game instances.

Client availability

A compatible client is required. This addon alone does not run or display a game on a phone. The planned paid App Store client is not yet released. Client source and build instructions are available at https://github.com/shinriyo/GodotRemote/tree/develop/godot4 . Older Godot Remote clients use a different protocol and are not compatible.

Network and licensing

Traffic, including optional passwords, is unencrypted. Use a trusted local network.

This is independent software, not an official Godot Engine product. The original Godot Remote project is by DmitriySalnikov; the included MIT license preserves its attribution. The free addon and source remain available independently of the planned paid client.