diff --git a/README.md b/README.md index 81b1ea7..8e472e6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # gopher64 +(gopher64 also has a GUI that can be launched by just running the executable) ``` Usage: gopher64 [OPTIONS] [GAME] @@ -11,6 +12,8 @@ Options: -c, --configure-input-profile Create a new input profile (keyboard/gamepad mappings). + -u, --use-dinput + Use DirectInput when configuring a new input profile. -b, --bind-input-profile Must also specify --port. Used to bind a previously created profile to a port -l, --list-controllers @@ -19,6 +22,8 @@ Options: Must also specify --port. Used to assign a controller listed in --list-controllers to a port -p, --port Valid values: 1-4. To be used alongside --bind-input-profile and --assign-controller + -z, --clear-input-bindings + Clear all input profile bindings and controller assignments -h, --help Print help -V, --version @@ -28,6 +33,18 @@ Options: There is no dedicated server at this point, but there is a #gopher64 channel on the simple64 server: https://discord.gg/R2cz7S94vD +## controls + +Keys are mapped according to mupen64plus defaults: https://mupen64plus.org/wiki/index.php/KeyboardSetup#2._Default_Key_Mappings_for_SDL-Input_Plugin. Xbox-style controllers also have a default mapping applied. + +You can create you own mappings by running `./gopher64 --configure-input-profile my_profile`. You then bind that profile to a port: `./gopher64 --bind-input-profile my_profile --port 1` + +In order to use a controller (for example, an Xbox controller), run `./gopher64 --list-controllers` to get a list of attached controllers, and then assign it by doing `./gopher64 --assign-controller --port 1` + +## portable mode + +If you would like to keep all the game data in the same folder as executable, you just need to create a file called "portable.txt" in the same directory as the executable. + ## goals 1. Performance. I want to be able to use this emulator on my laptop. @@ -42,18 +59,6 @@ There is no dedicated server at this point, but there is a #gopher64 channel on 4. `cargo build --release` 5. `./target/release/gopher64 /path/to/rom.z64` -## controls - -Keys are mapped according to mupen64plus defaults: https://mupen64plus.org/wiki/index.php/KeyboardSetup#2._Default_Key_Mappings_for_SDL-Input_Plugin. Xbox-style controllers also have a default mapping applied. - -You can create you own mappings by running `./gopher64 --configure-input-profile my_profile`. You then bind that profile to a port: `./gopher64 --bind-input-profile my_profile --port 1` - -In order to use a controller (for example, an Xbox controller), run `./gopher64 --list-controllers` to get a list of attached controllers, and then assign it by doing `./gopher64 --assign-controller --port 1` - -## portable mode - -If you would like to keep all the game data in the same folder as executable, you just need to create a file called "portable.txt" in the same directory as the executable. - ## contributing I am very open to contributions! Please reach out to me via a GitHub issue, or via discord (loganmc10) before doing substantial work on a PR.