### VERY WORK-IN-PROGRESS<\/p>\n
A figura addon that allows you to open and use TCP sockets.<\/p>\n
### You can contact me at `ktzukii` on Discord if the mod crashes your game, or doesn’t work as intended.
\n#### (please attach the logs on the message, if not you’re getting a “invalid, read description”)<\/p>\n
## Documentation:<\/p>\n
### SocketAPI (global `socket`)<\/p>\n
**These functions WILL return nil if the client (game) running the avatar (your scripts and model) is not the host (eg. your game will return a `LuaSocket` instance, others will return `nil`.)**
\n**So please add host checks on your socket scripts, otherwise your avatar will error on other clients, and will cause unneccesary trouble and confusion.**<\/p>\n
`SocketAPI:newSocket(String host, Number port) -> LuaSocket`
\nOpens a new socket, will print errors in log or throw vm error.<\/p>\n
`SocketAPI:newWebsocket(String host, Number port) -> LuaWebsocket`
\nOpens a new websocket, will print errors in log or throw vm error.<\/p>\n
`SocketAPI:closeAllSocket()`
\nClose all sockets on the current avatar<\/p>\n
`SocketAPI:closeAllWebsocket()`
\nClose all websockets on the current avatar<\/p>\n
`SocketAPI:closeAll() -> nil`
\nCloses all sockets and\/or websockets on the current avatar<\/p>\n
### LuaSocket<\/p>\n
`LuaSocket:send(String data) -> nil`
\nSends data, limited to strings due to how I wrote this mod. (working on changing that)<\/p>\n
`LuaSocket:recv() -> string`
\nRecieves data, also limited to strings. (see above)<\/p>\n
`LuaSocket:hasData() -> boolean`
\nGets whether or not there is a message to be received, which can then be gotten by `LuaSocket:recv()`<\/p>\n
`Luasocket:close() -> nil`
\nCloses the socket, cleanly.
\n**Sockets close automatically on avatar destroy\/reload, but it’s not a clean close.**<\/p>\n
### LuaWebsocket
\n**Websockets are known to be buggy at this time.**<\/p>\n
`LuaWebsocket:send(String data) -> nil`
\nSends data, limited to strings due to my understanding of Java.<\/p>\n
`LuaWebsocket:recv() -> string`
\nRecieves data, also limited to strings. (see above)<\/p>\n
`LuaWebsocket:hasData() -> boolean`
\nGets whether or not there is a message to be received, which can then be gotten by `LuaWebsocket:recv()`<\/p>\n
`LuaWebsocket:close(String reason) -> nil`
\nCloses the socket, cleanly.
\n**Sockets close automatically on avatar destroy\/reload, but it’s not a clean close.**<\/p>\n
## Examples: ### Python server # 127.0.0.1 restricts it to only your network, 0.0.0.0 lets anyone connect; def client(sock:socket.socket,addr:tuple[str,int]): # what i would use if it was a server instead of a echo def run(): threading.Thread( if __name__==”__main__”: ### Lua client — `127.0.0.1` == `localhost` (`localhost` gets autotranslated into `127.0.0.1`) — check if the socket did open — register a tick event (function runs every tick) There are no more examples as of writing.<\/p>\n","protected":false},"excerpt":{"rendered":" A Figura Addon that allows TCP sockets and more.<\/p>\n","protected":false},"featured_media":70055,"template":"","meta":{"_minecraft_slug":"figurasocketplugin","_minecraft_project_id":"RL7e9XCk","_minecraft_author":"Vaediam","_minecraft_license":"MIT","_minecraft_downloads":49,"_minecraft_follows":2,"_minecraft_client_side":"required","_minecraft_server_side":"unsupported","_minecraft_storage_type":"zip","_minecraft_archive_name":"figurasocketplugin.zip","_minecraft_size_bytes":81217,"_minecraft_version_count":7,"_minecraft_updated_at":"2026-05-16T13:54:40.090064Z","_minecraft_date_created":"2026-05-03T02:54:07.917164Z","_minecraft_date_modified":"2026-05-02T09:47:58.574730Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/figurasocketplugin","_minecraft_icon_attachment_id":70055,"_minecraft_imported_at":"2026-06-03T23:41:49+00:00","_minecraft_import_hash":"cf8e37030a284227c130a37581983943","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,873,92],"mod_loader":[99],"minecraft_version":[36,94,62,37,73,74,38],"class_list":["post-70054","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-library","mod_category-utility","mod_loader-fabric","minecraft_version-1-20-1","minecraft_version-1-20-4","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4"],"yoast_head":"\n
\n**This mod can interact with any TCP socket or websocket, not just python’s.**<\/p>\nPython & Lua interaction (Socket)<\/summary>\n
\n“`python
\nimport socket,json,threading<\/p>\n
\n# only if the port is open (forwarded), otherwise it won’t work.
\n# (check https:\/\/portforward.com\/ for help, this is not related to my mod.)
\nHOST,PORT=”127.0.0.1″,9985
\n# recommended to use high port numbers, anything above 1000<\/p>\n
\n # send stuff, the socket can only recieve strings, limitation of the mod right now.
\n # im working on expanding it to send more types, like tables\/dicts, etc.
\n while True:
\n try:
\n raw:bytes=sock.recv()
\n except: pass
\n sock.send(raw)
\n # close the connection after the message, no reason to keep it open
\n sock.close()
\n break<\/p>\n
\n # while True:
\n # try:
\n # raw:bytes=sock.recv()
\n # data:dict=json.loads(raw.decode())
\n # except: pass
\n # break<\/p>\n
\n with socket.create_server((HOST,PORT)) as server:
\n # make a loop so that it runs infinitely
\n while True:
\n # waits until a client connects THEN continues with running past this point
\n sock,addr=server.accept()
\n # sock : tcp socket
\n # addr : tuple[host,port]<\/p>\n
\n target=client,
\n args=[sock,addr])<\/p>\n
\n run()
\n“`<\/p>\n
\n“`lua
\nif not host:isHost() then
\n — dont run the rest of the script if the client running the avatar is not the host
\n return
\nend<\/p>\n
\nlocal sock=socket:newSocket(“127.0.0.1”,9985)
\n— socket:newSocket returns nil if the client running the avatar is not host;
\n— so we avoid errors via the above host check.
\n— socket:newSocket returns nil if the connection failed.<\/p>\n
\nif not sock then
\n print(“couldnt connect, check if your server is running”)
\n — and then return to stop errors if it didnt open
\n return
\nend<\/p>\n
\nevents.tick:register(function()
\n — check if the socket has data
\n if sock:hasData() then
\n local raw=sock:recv()
\n — then print said data
\n print(raw)
\n end
\nend)
\n“`<\/p>\n<\/details>\n