From ccc5c153900a3830268b274e55fb0ee419cb1e08 Mon Sep 17 00:00:00 2001 From: tippfehlr Date: Fri, 27 May 2022 23:12:51 +0200 Subject: [PATCH] README --- README.md | 11 ++++++++++- midi2vjoy.py | 3 ++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fe5a892..3b4abce 100644 --- a/README.md +++ b/README.md @@ -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 -m ` + +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 ` or `midi2vjoy.exe` if your device number is 1. + ``` _ _ _ ____ _ _ __ ___ (_) __| (_)___ \__ __ | | ___ _ _ @@ -13,7 +21,8 @@ works with endless encoders! Use MIDI controllers as joysticks with the help of midi2vJoy and vJoy. Usage: midi2vjoy -m -c [-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) diff --git a/midi2vjoy.py b/midi2vjoy.py index e37611a..bdbe9e4 100644 --- a/midi2vjoy.py +++ b/midi2vjoy.py @@ -341,7 +341,8 @@ def help_page(): Use MIDI controllers as joysticks with the help of midi2vJoy and vJoy. Usage: midi2vjoy -m -c [-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)