SkyHook
/
SkyHook-Unity
Archived
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: edit README for clarity

develop
CrackThrough 2022-11-06 23:41:11 +09:00
parent 5305be4f8d
commit 852cb106f4
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,32 +1,32 @@
# SkyHook-Unity # SkyHook-Unity
SkyHook for Unity SkyHook for Unity.
## Installation ## Installation
1. Open package manager with `Window -> Package Manager` 1. Open package manager with `Window -> Package Manager`.
2. Press `+` button and find `Add package from git URL...` 2. Click `+` button and find `Add package from git URL...`.
![Add package from git URL](images/tuto1.png) ![Add package from git URL](images/tuto1.png)
3. Paste `git+https://git.pikokr.dev/SkyHook/SkyHook-Unity.git` and click `Add` button.
3. Enter `git+https://git.pikokr.dev/SkyHook/SkyHook-Unity.git` and press `Add` button
## Usage ## Usage
### Start and stop hook ### Starting and stopping the hook
```cs ```cs
SkyHookManager.StartHook(); // Start Hook SkyHookManager.StartHook(); // Starts the hook
SkyHookManager.StopHook(); // Stop Hook, this is automatically called on exit SkyHookManager.StopHook(); // Stops the hook, this is automatically called on exit
``` ```
### Receive events ### Receiving key events
> NOTE: SkyHook does **NOT** give the correct key code. So you can't know what key the user actually pressed. > NOTE:
> - `Label` field for labelling keys' names such as F11
> - `Key` field is the raw key code from native module.
```cs ```cs
SkyHookManager.KeyUpdated.AddListener(ev => { SkyHookManager.KeyUpdated.AddListener(ev => {
// Your code // Your code
}); });
``` ```