Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eviltwo committed Jul 8, 2024
1 parent e7f8572 commit 48d671c
Showing 1 changed file with 7 additions and 31 deletions.
38 changes: 7 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,11 @@
# Input Glyphs
Displays glyphs (icons) of keyboard & mouse or controller buttons recognized by Unity's InputSystem.
InputGlyphs is a package designed to display button glyph images (icons) of input devices detected by Unity's InputSystem. It is easy to install and designed to allow for the extension of devices and glyph images.

Easy to use and extensible. Glyph images are taken from [Xelu's FREE Controller Prompts](https://thoseawesomeguys.com/prompts/) (CC0). This package can also load Glyphs for Gamepads provided by Steamworks.
The glyph images in the game will automatically switch according to the device in use.

![duo](https://github.com/eviltwo/InputGlyphs/assets/7721151/93cadf60-385d-44ea-86b5-50b2e4ba28f6)
The package includes pre-configured glyph images for keyboards & mice and various controllers, but you can add or change your own glyph images or use the glyphs provided by Steamworks.

|Supported deveices|
|---|
|Keyboard & Mouse|
|Xbox controller|
|Playstation controller|
|Switch pro controller|

|Glyph display modules|
|---|
|Text Mesh Pro|
|UI Image|
|Sprite Renderer|


|Other contents|Status|
|---|:---:|
|Sample scenes||
|Useage document|writing|

# Required packages
- Core system
- InputSystem
- Sprite in UI Text (optional)
- TextMeshPro
- Use gamepad glyphs provided by Steamworks (optional)
- [Steamworks.NET](https://github.com/rlabrecque/Steamworks.NET)
- [SteamInputAdapter](https://github.com/eviltwo/UnitySteamInputAdapter)
- [SteamInputGlyphLoader](https://github.com/eviltwo/UnitySteamInputGlyphLoader)
![Duo player glyphs](https://eviltwo.github.io/InputGlyphs_Docs/assets/duo_glyphs.png)

# Install with AssetStore
Comming soon!
Expand All @@ -43,3 +16,6 @@ Publisher page: https://assetstore.unity.com/publishers/12117
```
https://github.com/eviltwo/InputGlyphs.git?path=InputGlyphs/Assets/InputGlyphs
```

# Documentation
https://eviltwo.github.io/InputGlyphs_Docs/

0 comments on commit 48d671c

Please sign in to comment.