From 5d0453614a91a6f5f3535689dad6d4e76b038ed4 Mon Sep 17 00:00:00 2001 From: Calcody-Lee Mcneill <90211507+PinkDiamond1@users.noreply.github.com> Date: Sun, 13 Mar 2022 20:44:39 +0000 Subject: [PATCH] Revert "Editorial suggestions" --- README.md | 46 ++++++++++++++++++++++------------------------ 1 file changed, 22 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ae747ba..87874c6 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,33 @@ -# Twitch Unity Deep Link Sample +# Twitch Unity Deeplink Sample -## What does this do? +## What does this do -This example shows you how to check if Twitch is installed on both Android and iOS in Unity. -Additionally, this showcases how to launch a broadcast for a particular game ID using the Twitch mobile app's deep link functionality. +This example shows you how to check if twitch is installed on both Android and IOS in Unity. +Additionaly, this showcases how to launch a broadcast for a particular game id using the Twitch mobile app's deeplink functionality -## How to use it +## How to use -Depending on which mobile platform and OS version you are targeting, you may need to make additional changes. -See additional details below for a given platform. +Depending on which mobile platform and OS version you are targeting you may need to make additional changes. +See below for additional details for a given platform. ### UI interface -The "Open Twitch" button will launch the Twitch mobile app. Buttons will disable if Twitch is not installed. +The open twitch button will simply launch the twitch app. (Buttons will disable if Twitch is not installed) -The input field (i.e. text box) is used to enter your game ID. A game ID can be retrieved via the [Get Games](https://dev.twitch.tv/docs/api/reference#get-games) API endpoint. -Once the game ID has been entered, tap the "Broadcast" button to start Twitch streaming via the deep link functionality. +The input text box is used to enter your game id. Getting the game id can be done via this api: https://dev.twitch.tv/docs/api/reference#get-games +Once the game id has been entered push the "Broadcast" button to start twitch streaming via the deeplink functionality. ### Android -On Unity 2021 and above, no changes will be needed. +On Unity 2021 and above no changes will be needed. -When using Unity 2020, the following manifest change is required: +When using Unity 2020 it will require the following manifest change: - +`` -When using Unity 2019 or earlier, the following manifest changes are required. Note this was not tested but should work: +When using Unity 2019 or earlier the following manifest changes will be required. +(Note this was not tested but should work): @@ -44,25 +45,22 @@ When using Unity 2019 or earlier, the following manifest changes are required. N ### IOS -You must add "twitch" in `LSApplicationQueriesSchemes` to your app's Info.plist file. +You must add twitch in LSApplicationQueriesSchemes to your app's Info.plist There are two ways to do so: +1. Manually via editing the plist, this will require you to export to xcode -#### 1. Manually editing the plist - -This will require you to export to Xcode. plist example: +plist example: LSApplicationQueriesSchemes twitch -More documentation can be found [here](https://developer.apple.com/documentation/uikit/uiapplication/1622952-canopenurl?language=objc). - -#### 2. Programmatically editing the plist +More documentation can be found here: https://developer.apple.com/documentation/uikit/uiapplication/1622952-canopenurl?language=objc -An example can be found [here](https://github.com/Nrjwolf/unity-ios-can-open-url#example). +2. Alternatively you can do this programatically. Find an example here: https://github.com/Nrjwolf/unity-ios-can-open-url#example -## Acknowledgments and appendix +## Acknowledgments and Appendix -Specials thanks to @Nrjwolf for creating [UNITY-IOS-CAN-OPEN](https://github.com/Nrjwolf/unity-ios-can-open-url). +Specials thanks to Nrjwolf for creating UNITY-IOS-CAN-OPEN: https://github.com/Nrjwolf/unity-ios-can-open-url