Skip to content

Commit 4c79189

Browse files
committed
Update README to clarify Lua script setup, add CONSOLE_TYPE configuration, and script descriptions
1 parent 39060db commit 4c79189

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ For emulators like BizHawk, use the TCP protocol on port **5556**.
7878
We provide a ready-to-use client script: [`scripts/bizhawk_ai_agent.lua`](scripts/bizhawk_ai_agent.lua).
7979

8080
#### Setup
81-
1. **Configuration**: Open `scripts/bizhawk_ai_agent.lua` and adjust the button mapping in `apply_controls` to match your specific console/game.
81+
1. **Configuration**: Open `scripts/bizhawk_ai_agent.lua` and set `CONSOLE_TYPE` to `"SNES"` or `"NES"`. The script includes predefined button mappings for these consoles.
8282
2. **Run**: In BizHawk, go to **Tools -> Lua Console -> Script -> Open Script** and select `scripts/bizhawk_ai_agent.lua`.
8383

8484
#### Protocol Details
@@ -124,7 +124,9 @@ python scripts/serve.py models/nvidia/NitroGen/ng.pt
124124
* `nitrogen/`: Core library code (model definition, inference logic).
125125
* `scripts/`: Executable scripts.
126126
* `serve.py`: The main server entry point.
127-
* `play.py`: Client script for running agents.
127+
* `play.py`: Python client script for running agents.
128+
* `bizhawk_ai_agent.lua`: Lua client script for BizHawk emulator.
129+
* `start.sh`: Entrypoint script for Docker.
128130
* `models/`: Directory for storing downloaded model weights (gitignored).
129131
* `tests/`: Unit and integration tests.
130132
* `Dockerfile`: Definition for the server container.

0 commit comments

Comments
 (0)