Skip to content
This repository has been archived by the owner on Jul 23, 2024. It is now read-only.

A websocket client for Garry's Mod intended to retrieve scene and frame data from SFM Bridge.

License

Notifications You must be signed in to change notification settings

KiwifruitDev/sfm-bridge-gmod

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SFM Bridge for Garry's Mod

A websocket client for Garry's Mod intended to retrieve scene and frame data from SFM Bridge.

This software can be used to replicate scenes from Source Filmmaker with 1:1 accuracy.

Installation

The GWSockets binary module must be installed first, see its documentation for more details.

Once GWSockets is installed, clone this repository to your Garry's Mod's addons directory.

You should now be able to access console commands with the sfm_bridge_ prefix when loaded.

Usage

Requires the use of an SFM Bridge-compatible proxy server and an instance of SFM Bridge.

The SFM Bridge Proxy is provided for ease of use.

To run the proxy server, you must have node.js v16 or higher installed.

Connecting to a server

When a server is running, you can connect to it by running the sfm_bridge_connect command.

The default server IP is wss://localhost:9191/, it can be changed via the sfm_bridge_ip convar.

This addon can be restricted to super admins only using the sfm_bridge_restrict convar.

Once the client has successfully connected, when data is transmitted it should update your game automatically.

License

This software is licensed under the MIT License.

About

A websocket client for Garry's Mod intended to retrieve scene and frame data from SFM Bridge.

Topics

Resources

License

Stars

Watchers

Forks

Languages