bendns' repos / remap
addon for remapping inputs
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index b531e3b..4abbe2c 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,28 @@
-# godot cli parser
+# Input remapping tool
[![version](https://img.shields.io/badge/4.x-blue?logo=godot-engine&logoColor=white&label=godot&style=for-the-badge)](https://godotengine.org "Made with godot")
[![package](https://img.shields.io/npm/v/@bendn/remap?label=version&style=for-the-badge)](https://www.npmjs.com/package/@bendn/remap)
<a href='https://ko-fi.com/bendn' title='Buy me a coffee' target='_blank'><img height='28' src='https://storage.ko-fi.com/cdn/brandasset/kofi_button_red.png' alt='Buy me a coffee'> </a>
-A utility for parsing command line arguments for godot.
+A tool that allows the remapping of `InputMap` actions in godot4.
+
+## Features
+
+[![image](https://raw.githubusercontent.com/bend-n/remap/main/.github/screen.png)](_blank "Some themage required")
+
+Supports:
+
+- Multiple joypad types:
+ - Xbox
+ - Nintendo switch
+ - Playstation
+ - Fallback icons for a generic controller.
+- Keyboard
+- Mouse
+
+> **Warning** The Switch, Playstation icons are not tested, as I do not have them.
+
+> **Note** Nintendo switch does not have a guide button--the xbox or ps button--so beware.
## Usage