Skip to content

Commit 00a2449

Browse files
committed
Updated README
1 parent 052c341 commit 00a2449

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,21 @@ The `RadialControllerUnity` folder is a functioning example project with all nec
1515

1616
To get started using a Radial Controller in your own Unity Project do the following:
1717

18+
### Installation Option 1:
19+
20+
Download & import the latest `.unitypackage` from the GitHub releases page of this repository.
21+
22+
### Installation Option 2:
23+
1824
1. Copy this folder to your project's Asset folder:
1925
- `RadialControllerUnity/RadialController`
2026
2. Copy this executable to your project's StreamingAssets folder.
2127
- `RadialControllerUnity/StreamingAssets/RadialControllerServer.exe`
22-
3. In your Unity scene, attach the `RadialController` component to a GameObject.
23-
4. Hook up event handlers to the various `RadialController` components UnityEvents and do all your Unity game logic from there.
28+
29+
### How to use
30+
31+
1. In your Unity scene, attach the `RadialController` component to a GameObject.
32+
2. Hook up event handlers to the various `RadialController` components UnityEvents and do all your Unity game logic from there.
2433

2534
## How does it work
2635
When you play your Unity project, the `RadialController` Unity component will attempt to create a bridge to communicate with the Radial Controller device depending on the platform being run on.

RadialControllerUnity/Assets/RadialController/RadialController.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ private void OnEnable() {
3333
_bridge = PlatformBridgeFactory.CreateBridge(this);
3434

3535
if (_bridge != null) {
36-
Debug.LogFormat("[RadialController] Created platform bridge {0} {1}.", _bridge.Name, _bridge.Version);
36+
Debug.LogFormat("[RadialController] Created platform bridge: {0} {1}.", _bridge.Name, _bridge.Version);
3737

3838
_bridge.onBridgeReady += OnBridgeReady;
3939
_bridge.onButtonClicked += OnButtonClicked;
@@ -53,7 +53,7 @@ private void OnEnable() {
5353

5454
private void OnDisable() {
5555
if (_bridge != null) {
56-
Debug.LogFormat("[RadialController] Disposing of platform bridge {0}", _bridge.GetType().Name);
56+
Debug.LogFormat("[RadialController] Disposing of platform bridge: {0}", _bridge.Name);
5757
_bridge.Dispose();
5858
_bridge = null;
5959
}

RadialControllerUnity/Assets/StreamingAssets.meta

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)