rhetenor/flippr-code
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jonas Zeunert
2024-02-25 21:14:27 +01:00
parent 484f8f26e7
commit d022c67a58
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -3,8 +3,6 @@ This is a driver written to control Zaccaria pinball machines from the 2nd Gener
An example game implementation for the Zaccaria Pinball Champ '82 can be found at [[flippr-game|https://gitlab.rhetenor.de/rhetenor/flippr-game]]. An example game implementation for the Zaccaria Pinball Champ '82 can be found at [[flippr-game|https://gitlab.rhetenor.de/rhetenor/flippr-game]].
## Architecture
## Build Instructions ## Build Instructions
By default a static library gets build together with a networking target which enables communication over a UNIX Socket, for possible games. By default a static library gets build together with a networking target which enables communication over a UNIX Socket, for possible games.
@@ -48,10 +46,10 @@ We added a script /usr/bin/reset_flippr this can be found in the repo and must b
When built with the networking target (default), the driver is accessible via two UNIX Domain Socket through a simple HTTP/REST API. When built with the networking target (default), the driver is accessible via two UNIX Domain Socket through a simple HTTP/REST API.
The sockets can be found either in the folder specified through the env variable `XDG_RUNTIME_DIR` or if it is not set in `/tmp`. The sockets can be found either in the folder specified through the env variable `XDG_RUNTIME_DIR` or if it is not set in `/tmp`.
The sockets are: The sockets are:
* `S.flippR_driver.in`: All input events that occure on the pinball machine get pushed there. * `S.flippR_driver.in`: All input events that occure on the pinball machine get pushed there.
* `S.flippr_driver.out`: With this socket the driver can be controlled. * `S.flippr_driver.out`: With this socket the driver can be controlled.
An example connector writtin in Python can be found in the TUI [[FlippR_Networking.py|https://gitlab.rhetenor.de/rhetenor/flippr-code/src/branch/master/cli/FlippR_Networking.py]] An example connector writtin in Python can be found in the TUI [[FlippR_Networking.py|https://gitlab.rhetenor.de/rhetenor/flippr-code/src/branch/master/cli/FlippR_Networking.py]]