https://github.com/mklabs/ue-xelu-icons

Xelu's Controllers & Keyboard Prompts as an Unreal Plugin for programmatic use (cpp / bp)
https://github.com/mklabs/ue-xelu-icons

unreal unreal-engine unreal-engine-4 unreal-engine-plugin

Last synced: 7 days ago
JSON representation

Xelu's Controllers & Keyboard Prompts as an Unreal Plugin for programmatic use (cpp / bp)

• Host: GitHub
• URL: https://github.com/mklabs/ue-xelu-icons
• Owner: mklabs
• License: mit
• Created: 2022-01-31T13:00:48.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-13T15:50:26.000Z (about 1 month ago)
• Last Synced: 2024-10-30T00:39:31.672Z (18 days ago)
• Topics: unreal, unreal-engine, unreal-engine-4, unreal-engine-plugin
• Language: C++
• Homepage:
• Size: 5.62 MB
• Stars: 23
• Watchers: 3
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ue-xelu-icons

[Xelu's FREE Controllers & Keyboard Prompts](https://thoseawesomeguys.com/prompts/) as an Unreal Plugin for programmatic use (cpp / bp)



  



This plugin exposes a Blueprint Library with helpers to return an icon texture (either as a soft object reference or resolved UTexture2D) matching either:

- a Key directly

- an Input name from Input Settings

- an Input Action and Mapping Context

Content folder also has a few UMG Blueprint widgets, but those are more for testing and demonstration purpose rather than being part of the core functionality of the plugin.

## Usage

Here is the list of BP Exposed methods:

![xelu_lib_1920](https://user-images.githubusercontent.com/113832/152030870-3e97c506-f387-4b7d-bbc0-19299f4d0a1e.png)

Those methods use internally a Datatable whose main purpose is to define the mapping between Unreal `FKey` and the path to the matching icon textures. Row name key (first column) follows the `IconType.Key` pattern where `IconType` can be one of the following value: `Keyboard`, `PS4`, `PS5`, `XboxOne`, `XboxSeries`.

Link to the google sheet: https://docs.google.com/spreadsheets/d/1QsfkbC6ATr4prhD_RdyfXtI1v61gKn3a10HULff1NYM

The icons datatable can be changed in Plugin Settings: `Project Settings > Plugins > Xelu Icons`

If you need to add or edit icon mappings, I recommend doing a duplicate of this Datatable (parent table row: `XeluIconsInputsMetaData`) and changing the configuration to match yours.

## Credits

The icon textures that can be found in the Content folder are coming from [Xelu's Controllers & Keyboard Prompts](https://thoseawesomeguys.com/prompts/).

Huge thanks to Nicolae Berbece and ["Those Awesome Guys"](https://thoseawesomeguys.com/) for releasing this pack in the public domain under Creative Commons 0 (CC0).

## License

Icon textures made by Nicolae remain under Creative Commons 0 (CC0).

All other code surrounding it related to making it available as an Unreal Engine plugin is MIT licensed.