addon for remapping inputs
readme update
bendn 2022-12-08
parent a9edea7 · commit 063d461
-rw-r--r--.github/icon.pngbin0 -> 4968 bytes
-rw-r--r--.github/screen.pngbin6990 -> 2766 bytes
-rw-r--r--.github/screen1.pngbin0 -> 4076 bytes
-rw-r--r--README.md16
-rw-r--r--addons/remap/README.md16
-rw-r--r--addons/remap/package.json2
6 files changed, 17 insertions, 17 deletions
diff --git a/.github/icon.png b/.github/icon.png
new file mode 100644
index 0000000..5b08f6a
--- /dev/null
+++ b/.github/icon.png
Binary files differ
diff --git a/.github/screen.png b/.github/screen.png
index 253bd8a..7c67f3f 100644
--- a/.github/screen.png
+++ b/.github/screen.png
Binary files differ
diff --git a/.github/screen1.png b/.github/screen1.png
new file mode 100644
index 0000000..231b2ac
--- /dev/null
+++ b/.github/screen1.png
Binary files differ
diff --git a/README.md b/README.md
index 1e5831c..4e57e39 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Input remapping tool
+# RemapTools
[![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)
@@ -8,7 +8,8 @@ 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")
+[![image](https://raw.githubusercontent.com/bend-n/remap/main/.github/screen.png)](_blank "Key, Mouse support")<br>
+[![image](https://raw.githubusercontent.com/bend-n/remap/main/.github/screen1.png)](_blank "Gamepad support")
Supports:
@@ -16,7 +17,7 @@ Supports:
- Xbox
- Nintendo switch
- Playstation
- - Fallback icons for a generic controller.
+ - Fallback icons for a generic controller
- Keyboard
- Mouse
@@ -27,11 +28,10 @@ Supports:
## Usage
```gdscript
-const RemapButton = preload("res://addons/remap/RemapButton.gd")
-var label = RemapButton.new()
-label.action = "ui_left"
-label._name = "left"
-add_child(label)
+var button = RemapButton.new()
+button.action = "ui_left"
+button._name = "left"
+add_child(button)
```
## Installation
diff --git a/addons/remap/README.md b/addons/remap/README.md
index 4274e7e..a6f8e55 100644
--- a/addons/remap/README.md
+++ b/addons/remap/README.md
@@ -1,4 +1,4 @@
-# Input remapping tool
+# RemapTools
[![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")
<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>
@@ -7,7 +7,8 @@ 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")
+[![image](https://raw.githubusercontent.com/bend-n/remap/main/.github/screen.png)](_blank "Key, Mouse support")<br>
+[![image](https://raw.githubusercontent.com/bend-n/remap/main/.github/screen1.png)](_blank "Gamepad support")
Supports:
@@ -15,7 +16,7 @@ Supports:
- Xbox
- Nintendo switch
- Playstation
- - Fallback icons for a generic controller.
+ - Fallback icons for a generic controller
- Keyboard
- Mouse
@@ -26,11 +27,10 @@ Supports:
## Usage
```gdscript
-const RemapButton = preload("res://addons/remap/RemapButton.gd")
-var label = RemapButton.new()
-label.action = "ui_left"
-label._name = "left"
-add_child(label)
+var button = RemapButton.new()
+button.action = "ui_left"
+button._name = "left"
+add_child(button)
```
## Installation
diff --git a/addons/remap/package.json b/addons/remap/package.json
index cc7057d..1506429 100644
--- a/addons/remap/package.json
+++ b/addons/remap/package.json
@@ -1,6 +1,6 @@
{
"name": "@bendn/remap",
- "version": "5.0.2",
+ "version": "5.0.4",
"description": "godot input remapping",
"main": "InteractiveActionLabel.gd",
"scripts": {