Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
tippfehlr committed May 27, 2022
1 parent 7bb8626 commit ccc5c15
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

works with endless encoders!

1. Download and install vJoy from [sourceforge](https://sourceforge.net/projects/vjoystick/)
2. Download midi2vjoy.exe from the [latest release](https://github.com/tippf3hlr/midi2vjoy/releases)
3. Test the MIDI connection with `midi2vjoy.exe -t`
4. Create mapping (Help: `midi2vjoy --config-help` or down below)
5. Start midi2vjoy.exe with `midi2vjoy.exe -c <your config file> -m <midi device id>`

If your config file is named `mapping.conf` and is located in the same directory as midi2vjoy.exe, you can start midi2vjoy with just `midi2vjoy.exe -m <midi device id>` or `midi2vjoy.exe` if your device number is 1.

```
_ _ _ ____ _
_ __ ___ (_) __| (_)___ \__ __ | | ___ _ _
Expand All @@ -13,7 +21,8 @@ works with endless encoders!
Use MIDI controllers as joysticks with the help of midi2vJoy and vJoy.
Usage: midi2vjoy -m <midi_device> -c <config_file> [-v]
-h --help: shows help regarding the config file
-h --help: shows this help page
--config-help instructions to create a config file
-t --test: display raw MIDI input
-m --midi: MIDI device to use. To see available devices, use -t
-c --config: path to a config file (see example_config.conf)
Expand Down
3 changes: 2 additions & 1 deletion midi2vjoy.py
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,8 @@ def help_page():
Use MIDI controllers as joysticks with the help of midi2vJoy and vJoy.
Usage: midi2vjoy -m <midi_device> -c <config_file> [-v]
-h --help: shows help regarding the config file
-h --help: shows this help page
--config-help instructions to create a config file
-t --test: display raw MIDI input
-m --midi: MIDI device to use. To see available devices, use -t
-c --config: path to a config file (see example_config.conf)
Expand Down

0 comments on commit ccc5c15

Please sign in to comment.