add roadmap and update readme
This commit is contained in:
parent
0e47489209
commit
174bb2d323
19
README.md
19
README.md
|
|
@ -1,16 +1,19 @@
|
|||
# Sticky Viewer
|
||||
simple fightstick input viewer
|
||||
|
||||
appears always on top and at the bottom center of your display. very little configuration is possible atm but watch this space
|
||||
A simple XInput input viewer designed for fightsticks. Appears always-on-top.
|
||||
|
||||
currently supports only five buttons and only left and right stick directions, because i play fs and that's just the way it is i guess
|
||||
Currently, configuration is quite limited. Check ROADMAP.md for planned updates. Most notably, exactly five remappable buttons and only left and right stick directions are supported right now, because I play Fantasy Strike and that was my priority. :P
|
||||
|
||||
fightstick with no inputs:
|
||||
To remap buttons, open sticky_viewer.exe.config and modify the values there. If the configuration file is missing at runtime, the values used in the unmodified file are the defaults.
|
||||
|
||||

|
||||
## Screenshots
|
||||
|
||||
all buttons held and stick left:
|
||||
No inputs held:
|
||||
|
||||

|
||||

|
||||
|
||||
a configuration file for button remapping and image files for customization are provided. if they're missing at runtime, the program defaults to the default values and images
|
||||
All buttons held and stick held left:
|
||||
|
||||

|
||||
|
||||
The images composing the stick and button visuals are provided and can be customized. If they're missing at runtime, these defaults are used.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
# Roadmap
|
||||
|
||||
These are the plans for what I want to be customizable via .config modification and supplying custom images.
|
||||
|
||||
## Visual Customization
|
||||
|
||||
### Buttons
|
||||
|
||||
- How many buttons are visible ☐
|
||||
- Position of buttons ☐
|
||||
- Which hardware button is mapped to which visible button 🗹
|
||||
- Pressed and unpressed images of buttons 🗹
|
||||
- Override images for specific buttons ☐
|
||||
- e.g. something like this:
|
||||
|
||||

|
||||
|
||||
### Stick
|
||||
|
||||
- Choose between left analog, right analog or d-pad ☐
|
||||
- How the stick looks 🗹
|
||||
- Position of stick ☐
|
||||
- Hitbox mode ☐
|
||||
- Could be implemented by allowing you to turn off stick display and just adding more buttons, I guess
|
||||
- Analog directions would have to be made valid button inputs, but I'm already doing something like that for LT and RT
|
||||
|
||||
### Window
|
||||
|
||||
- Location (support both x/y coords and something like BOTTOM_MIDDLE, TOP_LEFT) ☐
|
||||
- Width and height ☐
|
||||
- Background (support both RGBA colour and a supplied image) ☐
|
||||
|
||||
## Misc
|
||||
|
||||
- Optionally assign "close" keybind to a combination of stick buttons ☐
|
||||
- Choose an XInput device instead of defaulting to whichever one is considered player 1 ☐
|
||||
- "Press Start" prompt if ambiguous, save to config file?
|
||||
- Keybinds to generate .config file and default images in execution folder ☐
|
||||
- This would allow the distribution of just the .exe file. If someone wishes to customize, those default resources could be generated from the program
|
||||
Loading…
Reference in New Issue