Skip to content

Commit

Permalink
Readme Updates
Browse files Browse the repository at this point in the history
Readme tweaks
  • Loading branch information
Rexeh committed Sep 16, 2020
1 parent 4616c1c commit bc6666a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
12 changes: 7 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,18 @@ Learning flight simulators is a daunting task, with lots of buttons to remember.

## What's supported?

### Joystick Gremlin
### General
- Custom SVG templates can be built to suit your joystick, throttle, custom HID device

### Joystick Gremlin
- Importing/inheriance of base templates into button profile exports
- Support for multiple profiles in Joystick Gremlin

## What's not supported (yet)
### What's not supported (yet)
- POV hats (In POV mode)
- AXIS support

### Support for other programs/games (yet)
### Support for other games
I'm currently working on DCS World - if you have a game you think will benefit from this, let me know and I might add it.

## Installation
Expand All @@ -42,8 +44,8 @@ I'm expecting issues with the Virpil templates, as don't have the logical button
- If it finds a match, it'll export the bindings for this device, and any modes you have configured
- Files will be stored in /diagrams when export has been completed. You can open these in a web browser, and print to PDF/printer from there

# Templates/Supported Devices
[Please read](templates/readme.md)
# Templates/Supported Joysticks
[Please read the about templates here](templates/readme.md)

# Support / Beer fund

Expand Down
14 changes: 6 additions & 8 deletions templates/readme.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Templates

Define templates in SVG. Name of template should match your Joystick Gremlin device name.

# Default Templates

## Virpil
**Thanks to MartinCo for help with the default logical buttons!**
These are iniital releases, and may require tweaking. Virpil are highly customisable and as such "Button_1" for one person may be "Button_2" for another

**Thanks to MartinCo for help with the templates**
- Virpil MT50-CM2 Stick
- Virpil MT50-CM2 Throttle
- Virpil Constellation Alpha-R
- Virpil Constellation Alpha-L
- Virpil Constellation Delta
- Virpil WarBRD Grip
- Virpil MT50 Throttle V2

## Thrustmaster
These should work out of the box with no customisation needed
- Warthog HOTAS
- Warthog Throttle

Expand All @@ -29,8 +29,6 @@ This is very easy to do, for free online
2. Create a joystick profile by importing a joystick image, and creating labels
3. Call the label BUTTON_X, where X is the actual physical button on your stick
4. Export template as SVG
5. Place this in /Templates with the relevant device name seen by windows

Now on execution of the program, you should have your binds automatically added to the app.
5. Place this in /Templates with the exact device name seen by windows

If you have created a template, happy to include it back in the repository (might make some edits to standardise it)
If you have created a template, happy to include it back in the repository.

0 comments on commit bc6666a

Please sign in to comment.