From fc6169f9543a6d5f6edeff7a268500d6bcd71858 Mon Sep 17 00:00:00 2001 From: viandoxdev Date: Wed, 31 Aug 2022 19:12:39 +0200 Subject: [PATCH] readme --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b91e9d --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# jsfw + +Linux only utility to forward uevent devices over network through a tcp connection. + +# Usage + +Start client: + +```sh +jsfw client [server address] [server port] +``` + +Start server: + +```sh +jsfw server [port] +``` + +When a device is connected to the server host, jsfw will notice it and assign it to one of the client which will in turn create a virtual device based on it. + +The code can theoretically support any kind of device (mouse, keyboard, joystick...) but is artificially limited to PS4 controllers (see `hid.c::filter_event`), because the hidraw interface used to set additional device state (led color, flashing, rumble) only works with them. This could be easily edited tho (see `hid.c::apply_controller_state`, `net.h::MessageControllerState`, `net.c::{msg_serialize, msg_deserialize}` and `client.c::JControllerState`). To set the controller state from the client write the json state to the fifo (either `/tmp/jsfw_fifo` or `/run/jsfw_fifo` depending on if `JSFW_DEV` was set during compilation, see `Makefile`). + +The format for the controller state takes this form (comments not allowed): + +```json +{ + "led_color": "#ff0000", // hex color string + "flash": [0.04, 0.11], // values are 0-1, first is time on second is time off + "rumble": [0, 0], // values are 0-1 +} +``` + +Any value can be ommitted, extra values will be ignored. + +# Building + +## Dependencies + +None apart from libc, libmath, pthreads, and linux headers. + +## Compiling + +Use the makefile, or open it and do things by hand, there's nothing magic in there. + +```sh +make jsfw +``` + +output will be `./jsfw`.