https://github.com/Bogenbai/Unity-ControlsTips

Zelda: BOTW style UI controls tips for Unity.
https://github.com/Bogenbai/Unity-ControlsTips

Last synced: 2 months ago
JSON representation

Zelda: BOTW style UI controls tips for Unity.

• Host: GitHub
• URL: https://github.com/Bogenbai/Unity-ControlsTips
• Owner: Bogenbai
• License: gpl-3.0
• Created: 2018-06-27T15:00:03.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-19T14:38:17.000Z (about 1 year ago)
• Last Synced: 2024-11-10T21:39:34.537Z (8 months ago)
• Language: C#
• Size: 8.97 MB
• Stars: 10
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Controls Tips

This package allows you to create Zelda: BOTW style UI controls tips.

![image](https://github.com/Bogenbai/Unity-ControlsTips/assets/26659946/3d524fb1-c801-4030-9271-bb7231b2d79d)

## Installing

1. Install ControlsTips.unitypackage into your project.

2. Move *ControlsTips ScrollView* from Prefabs folder into your canvas in your scene.

3. Configure tips list in component script  on *Controls Tips ScrollView* GameObject.

![image](https://github.com/Bogenbai/Unity-ControlsTips/assets/26659946/be17ff41-436b-4f58-8d33-2486d20f37e9)

* *Name* - Key for you to call the methods for actions with a specific tip.

* *Key Image* - Image of the key to be displayed on the screen.

* *Tip Description* - Description of the key action to be displayed on the screen.

## How to use it?

Now, when you've added *ControlsTips ScrollView* GameObject into your scene, you can simply call `ShowTip()` and `HideTip()` methods in your scripts.

*ControlsTips* is singleton, so you can call it like this:

*Example:*

```

if (isGrounded())

{

  ControlsTips.Instance.ShowTip("Jump");

}

else

{

  ControlsTips.Instance.HideTip("Jump");

}

```