/Godot-UnixSocket

GDExtension/GDNative module for UNIX socket support in Godot Engine

Primary LanguageC++MIT LicenseMIT

Godot-UnixSocket

GDExtension module for UNIX domain sockets support in Godot Engine under Linux and MacOS builds.

Build

Prerequisites

  1. Python
  2. SCons
  3. C/C++ compiler

Compiling

  1. Clone the repository:
git clone --recursive https://github.com/Abdera7mane/Godot-UnixSocket.git
cd Godot-UnixSocket
git submodule update --init --recursive
  1. Build with scons (outputs to bin):

debug build

scons target=template_debug

release build

scons target=template_release

Documentation

class StreamPeerUnix

Inherits: StreamPeerExtension < StreamPeer < RefCounted < Object

methods

return definition description
int open(path: String) Opens a connection to a socket at path and returns an error code
bool is_open() Checks if the stream peer is connected
String get_path() Gets the current connected socket path
void close() Closes the socket connection