aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAstatin <[email protected]>2025-07-03 22:12:32 +0200
committerAstatin <[email protected]>2025-07-03 22:12:32 +0200
commitbfe34191a52e356ce92df8e6b10d3ba2b4598fe8 (patch)
tree9c16eda8054601517da3118e1a12d9a99f2f05bb
parentab69dcb61fc426938c42c9d17715d224784596c3 (diff)
Update README
-rw-r--r--README.md8
-rw-r--r--src/main.rs2
2 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 932ea67..ebe7916 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,8 @@ emulator <gameboy_rom>
If you do not set the `-k` cli parameter, the emulator will try to find a gamepad.
+There is no automatic gamepad reconnection. The gamepad must be detected at the start of the emulator and not be disconnected.
+
If there is the message `No gamepad found` in the first messages, it means your gamepad hasn't been detected or initialized properly. Connect a gamepad and restart the emulator to fix it. It should print `Found Gamepad id: GamepadId(0)` instead.
(I don't know which gamepad exactly. The 8BitDo SF30 Pro in USB mode on Arch Linux works. That's all I know lol)
@@ -71,7 +73,11 @@ emulator <gameboy_rom> -k
## Serial communication
-Serial communication is currently work in progress and doesn't work with basic ROMs but the `--fifo-input` and `--fifo-output` can already be tested by passing files created with mkfifo. If the goal is to allow communication between two gameboy, one gameboy's input should be the other's output.
+Serial communication can be used through tcp using the -L and -c arguments.
+One gameboy will use the -L to listen for connection on a port and the other will connect to the first one using the ip address and port of the first one.
+
+If the two emulators are on the same machine, two linux fifo files can also be used with --fifo-input and --fifo-output.
+The files must be created before and the input fifo file of one must be the output of the other.
# Contributing
diff --git a/src/main.rs b/src/main.rs
index 4399548..821a76d 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -71,7 +71,7 @@ struct Cli {
#[arg(short='L', long)]
listen: Option<u16>,
- /// Serial tcp connect port
+ /// Serial tcp connect address <address:port>
#[arg(short, long)]
connect: Option<String>,