From e45a957338a62a8cc17d9bfc84d14ebab5ca687a Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 11:21:04 +0100 Subject: [PATCH 01/13] docs: Add Photon Realtime setup guide --- .../Images/Boss-Room-Host-Confirm.png | 3 + .../Images/Boss-Room-Host-Dropdown.png | 3 + .../Images/Boss-Room-Join-Dropdown.png | 3 + .../Photon-Realtime/Images/Boss-Room-Join.png | 3 + .../Images/Boss-Room-Lobby-Extra.png | 3 + .../Images/Boss-Room-Lobby.png | 3 + .../Photon-Realtime/Images/Photon-App.png | 3 + .../Images/Photon-Dashboard.png | 3 + Documentation/Photon-Realtime/Readme.md | 79 +++++++++++++++++++ 9 files changed, 103 insertions(+) create mode 100644 Documentation/Photon-Realtime/Images/Boss-Room-Host-Confirm.png create mode 100644 Documentation/Photon-Realtime/Images/Boss-Room-Host-Dropdown.png create mode 100644 Documentation/Photon-Realtime/Images/Boss-Room-Join-Dropdown.png create mode 100644 Documentation/Photon-Realtime/Images/Boss-Room-Join.png create mode 100644 Documentation/Photon-Realtime/Images/Boss-Room-Lobby-Extra.png create mode 100644 Documentation/Photon-Realtime/Images/Boss-Room-Lobby.png create mode 100644 Documentation/Photon-Realtime/Images/Photon-App.png create mode 100644 Documentation/Photon-Realtime/Images/Photon-Dashboard.png create mode 100644 Documentation/Photon-Realtime/Readme.md diff --git a/Documentation/Photon-Realtime/Images/Boss-Room-Host-Confirm.png b/Documentation/Photon-Realtime/Images/Boss-Room-Host-Confirm.png new file mode 100644 index 000000000..4edb986c4 --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Boss-Room-Host-Confirm.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:edae396114f77bf62295f83cf2a513fcfc9596f67b37fecf3ee0b79378ba50fb +size 204109 diff --git a/Documentation/Photon-Realtime/Images/Boss-Room-Host-Dropdown.png b/Documentation/Photon-Realtime/Images/Boss-Room-Host-Dropdown.png new file mode 100644 index 000000000..a7e97ea49 --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Boss-Room-Host-Dropdown.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9c18f020e23d826b0316fae5ff3880873efdbfdcb47505f0a0762995bda6eab1 +size 762042 diff --git a/Documentation/Photon-Realtime/Images/Boss-Room-Join-Dropdown.png b/Documentation/Photon-Realtime/Images/Boss-Room-Join-Dropdown.png new file mode 100644 index 000000000..602033212 --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Boss-Room-Join-Dropdown.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7bd55f6408858ca649d80f5bf79a2a106e4b0c1a53452a6e1cebaeb3a28dc120 +size 375009 diff --git a/Documentation/Photon-Realtime/Images/Boss-Room-Join.png b/Documentation/Photon-Realtime/Images/Boss-Room-Join.png new file mode 100644 index 000000000..e78f2715b --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Boss-Room-Join.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ad821bab2e1e6d654774d5e75142f96169ce4b7a7e58129451d7c1546219b944 +size 371873 diff --git a/Documentation/Photon-Realtime/Images/Boss-Room-Lobby-Extra.png b/Documentation/Photon-Realtime/Images/Boss-Room-Lobby-Extra.png new file mode 100644 index 000000000..ee09d0538 --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Boss-Room-Lobby-Extra.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7aab09621b8e591fd2ecf5305b8a71689821a7832aa2520c7944dd24e8770955 +size 4539880 diff --git a/Documentation/Photon-Realtime/Images/Boss-Room-Lobby.png b/Documentation/Photon-Realtime/Images/Boss-Room-Lobby.png new file mode 100644 index 000000000..481edff13 --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Boss-Room-Lobby.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:be7821de85a202196a933682c0a06fec6bf55f99de145a0cbe7e1266921b9ea4 +size 4331599 diff --git a/Documentation/Photon-Realtime/Images/Photon-App.png b/Documentation/Photon-Realtime/Images/Photon-App.png new file mode 100644 index 000000000..8b22a7b89 --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Photon-App.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ec7cac4bb30e9970d2c1832766d1b9c3fc1cf69adb2c263af7ba579442fb33c4 +size 200878 diff --git a/Documentation/Photon-Realtime/Images/Photon-Dashboard.png b/Documentation/Photon-Realtime/Images/Photon-Dashboard.png new file mode 100644 index 000000000..470a783a5 --- /dev/null +++ b/Documentation/Photon-Realtime/Images/Photon-Dashboard.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c36d4422f98f537eb6330e1378631498258f02c748b120fc9212568a9425e8fa +size 181469 diff --git a/Documentation/Photon-Realtime/Readme.md b/Documentation/Photon-Realtime/Readme.md new file mode 100644 index 000000000..b178a7b35 --- /dev/null +++ b/Documentation/Photon-Realtime/Readme.md @@ -0,0 +1,79 @@ +# Photon Setup Guide @Boss Room + +## Setup Photon + +1. Access Wizard from Window → Photon Realtime → Wizard +2. Click next until you get to the Photon Cloud Setup Part +3. If you don't already have an account or e-mail, click on the Visit Dashboard button in order to create one + 1. If you just created an account for the first time you need to also create a New Application from Photon's Dashboard + 2. NOTE! The Photon Type for Boss Room is: `Photon Realtime` + + ![Images/Photon-App.png](Images/Photon-App.png) + +4. Once an Application is setup, you will be able to get it's App ID from Photon's Dashboard, copy that to your clipboard + - NOTE! This App Id **must** be shared with other people in order to be able to connect to your Photon Room! + + ![Images/Photon-App.png](Images/Photon-Dashboard.png) + +5. Go back to the Photon Wizard Window of your Unity Project and paste the App Id there +6. Click on Setup + - It should show something like: "Your AppId is now applied to this Project **Done** " +7. Click on Next, then Done, you should be all setup now! +8. You can safely quit the Photon Wizard now! + +## Preparing Boss Room to be built + +Follow these steps in order to prepare Boss Room to be packaged and distributed to your audience: + +--- + +1. Find PhotonAppSettings asset in your project +2. The App Id you've set during the setup, should be shared with your friends in case they want to use the Unity Editor, instead of a packaged built, as each developer might a different App Id/region set in its PhotonAppSettings asset + - NOTE! We suggest considering Playing in Editor with your friends only for iteration purposes - when they have access to your project - as we encourage you to distribute your packaged builds to your friends, because sometimes they might have some local changes that would cause different issues which might be hard to debug. +3. Now, you should be able to build Boss Room and distribute it to your friends/users. + +## Playing Boss Room with friends + +Once the setup is done, there are two ways you can actually test out is working, one way is to launch the Boss Room project via a packaged build or to use the Unity Editor, but do that with caution! (see more info above). With that being said, both ways almost the same in terms of how you host/join a session. + +--- + +NOTE! Just to reiterate, it is very important that all the Unity Editor users should have the exact same version of the project with no changes locally and their PhotonAppSettings should match with the Host's one. + +--- + +### Hosting a Room + +--- +If you want to host a session then: + + +1. Click the Start button +2. Select `Relay Host` from the dropdown on the left + ![Images/Boss-Room-Host-Dropdown.png](Images/Boss-Room-Host-Dropdown.png) + +3. A random generated room name will be assigned. + ![Images/Boss-Room-Host-Confirm.png](Images/Boss-Room-Host-Confirm.png) + +4. Share the generated room name with your users, and click confirm! + +5. Done! You are now in the Lobby - also known as the Character Selection Screen, your friends/users should be able to join know. + +- NOTE! You can see the Room Name, in the top-left corner! + ![Images/Boss-Room-Lobby.png](Images/Boss-Room-Lobby.png) + +### Joining a Room + +--- + +If you want to Join a session then: +1. Click the Join Button and select `Relay Host` from the dropdown on the left + ![Images/Boss-Room-Join-Dropdown.png](Images/Boss-Room-Join-Dropdown.png) +2. You should be asked to input the room name below + ![Images/Boss-Room-Join.png](Images/Boss-Room-Join.png) + +3. In this example, the room name is: `YQWOWS` + +4. Click Join, and once successfully connected, now you should be in the Lobby with the rest of your friends . + ![Images/Boss-Room-Lobby-Extra.png](Images/Boss-Room-Lobby-Extra.png) + \ No newline at end of file From 6cb05dc73428d950c218fcfd83af2cdfc9755567 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 11:24:00 +0100 Subject: [PATCH 02/13] docs: small typo in the Photon Setup Guide --- Assets/Photon/Resources/PhotonAppSettings.asset | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Assets/Photon/Resources/PhotonAppSettings.asset b/Assets/Photon/Resources/PhotonAppSettings.asset index f09351165..b6a23067c 100644 --- a/Assets/Photon/Resources/PhotonAppSettings.asset +++ b/Assets/Photon/Resources/PhotonAppSettings.asset @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:c99169ab5731631db3a5a25d8124d31e473ca0ab2a0f052bd93f611a6090acbe -size 713 +oid sha256:63d6ad4ab54a04738ba8f9c44ccc3125fec4fd95b5ef799deef4b58eb74fc666 +size 749 From 5e76f2a976cc43dc92db791a3b6dfacf9bf696d7 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 11:25:41 +0100 Subject: [PATCH 03/13] docs: another small type in Photon Setup Guide readme --- Documentation/Photon-Realtime/Readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/Photon-Realtime/Readme.md b/Documentation/Photon-Realtime/Readme.md index b178a7b35..0ce53e2da 100644 --- a/Documentation/Photon-Realtime/Readme.md +++ b/Documentation/Photon-Realtime/Readme.md @@ -4,8 +4,8 @@ 1. Access Wizard from Window → Photon Realtime → Wizard 2. Click next until you get to the Photon Cloud Setup Part -3. If you don't already have an account or e-mail, click on the Visit Dashboard button in order to create one - 1. If you just created an account for the first time you need to also create a New Application from Photon's Dashboard +3. If you don't already have an account or an App Id, click on the Visit Dashboard button in order to create one + 1. If you just created an account for the first time you need to also create a New Application from Photon's Dashboard 2. NOTE! The Photon Type for Boss Room is: `Photon Realtime` ![Images/Photon-App.png](Images/Photon-App.png) @@ -34,7 +34,7 @@ Follow these steps in order to prepare Boss Room to be packaged and distributed ## Playing Boss Room with friends -Once the setup is done, there are two ways you can actually test out is working, one way is to launch the Boss Room project via a packaged build or to use the Unity Editor, but do that with caution! (see more info above). With that being said, both ways almost the same in terms of how you host/join a session. +Once the setup is done, there are two ways you can actually test out is working, one way is to launch the Boss Room project via a packaged build or to use the Unity Editor, but do that with caution! (see more info above). With that being said, both ways are almost the same in terms of how you host/join a session. --- From e7ce5b102efd1938f24c66691114022d0daf81c2 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 16:08:54 +0100 Subject: [PATCH 04/13] Remove PhotonAppSettings.asset --- Assets/Photon/Resources/PhotonAppSettings.asset | 3 --- 1 file changed, 3 deletions(-) delete mode 100644 Assets/Photon/Resources/PhotonAppSettings.asset diff --git a/Assets/Photon/Resources/PhotonAppSettings.asset b/Assets/Photon/Resources/PhotonAppSettings.asset deleted file mode 100644 index b6a23067c..000000000 --- a/Assets/Photon/Resources/PhotonAppSettings.asset +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:63d6ad4ab54a04738ba8f9c44ccc3125fec4fd95b5ef799deef4b58eb74fc666 -size 749 From 99cc2eae902d012f61b8a39ea6643e365f7e1eb5 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 16:09:21 +0100 Subject: [PATCH 05/13] docs: update Photon Realtime Readme - remove the unimportant bits --- Documentation/Photon-Realtime/Readme.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/Documentation/Photon-Realtime/Readme.md b/Documentation/Photon-Realtime/Readme.md index 0ce53e2da..793a7fb2c 100644 --- a/Documentation/Photon-Realtime/Readme.md +++ b/Documentation/Photon-Realtime/Readme.md @@ -21,24 +21,17 @@ 7. Click on Next, then Done, you should be all setup now! 8. You can safely quit the Photon Wizard now! -## Preparing Boss Room to be built - -Follow these steps in order to prepare Boss Room to be packaged and distributed to your audience: - ---- - -1. Find PhotonAppSettings asset in your project -2. The App Id you've set during the setup, should be shared with your friends in case they want to use the Unity Editor, instead of a packaged built, as each developer might a different App Id/region set in its PhotonAppSettings asset - - NOTE! We suggest considering Playing in Editor with your friends only for iteration purposes - when they have access to your project - as we encourage you to distribute your packaged builds to your friends, because sometimes they might have some local changes that would cause different issues which might be hard to debug. -3. Now, you should be able to build Boss Room and distribute it to your friends/users. - ## Playing Boss Room with friends -Once the setup is done, there are two ways you can actually test out is working, one way is to launch the Boss Room project via a packaged build or to use the Unity Editor, but do that with caution! (see more info above). With that being said, both ways are almost the same in terms of how you host/join a session. +Once the setup is done, there are two ways you can actually test out is working, one way is to launch the Boss Room project via a packaged build or to use the Unity Editor, but do that with caution!. With that being said, both ways are almost the same in terms of how you host/join a session. + +``` + `IMPORTANT` There is a bug in MLAPI at the moment that could prevent users from connecting to each other through editor! +``` --- -NOTE! Just to reiterate, it is very important that all the Unity Editor users should have the exact same version of the project with no changes locally and their PhotonAppSettings should match with the Host's one. +NOTE! Just to reiterate, it is very important that all Unity Editor users should have the exact same version of the project with no changes locally and their PhotonAppSettings should match with the Host's one. --- From 6b748b09b06f700a7ab1156bb5b17582a1fb9fb2 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 16:29:34 +0100 Subject: [PATCH 06/13] Photon: adjust the message on the PopupPanel when users try to use relay mode --- Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs | 10 +++++++++- Documentation/Photon-Realtime/Readme.md | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs b/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs index fa990cd44..2d0d354bf 100644 --- a/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs +++ b/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs @@ -147,8 +147,16 @@ private void OnOnlineModeDropdownChanged(int value) { if (string.IsNullOrEmpty(PhotonAppSettings.Instance.AppSettings.AppIdRealtime)) { +#if UNITY_EDITOR // If there is no photon app id set tell the user they need to install - SetupNotifierDisplay("Photon Realtime not Setup!", "Follow the instructions in the readme to setup Photon Realtime and use relay mode.", false, true); + SetupNotifierDisplay( + "Photon Realtime not Setup!", "Follow the instructions in the readme (/Documents/Photon-Realtime/Readme.md) " + + "to setup Photon Realtime and use relay mode.", false, true); +#else + // If there is no photon app id set tell the user they need to install + SetupNotifierDisplay( + "Photon Realtime not Setup!", "It needs to be setup in the Unity Editor for this project by following the Photon-Realtime guide, then rebuild the project and distribute it.", false, true); +#endif return; } diff --git a/Documentation/Photon-Realtime/Readme.md b/Documentation/Photon-Realtime/Readme.md index 793a7fb2c..18d4ef24d 100644 --- a/Documentation/Photon-Realtime/Readme.md +++ b/Documentation/Photon-Realtime/Readme.md @@ -26,7 +26,7 @@ Once the setup is done, there are two ways you can actually test out is working, one way is to launch the Boss Room project via a packaged build or to use the Unity Editor, but do that with caution!. With that being said, both ways are almost the same in terms of how you host/join a session. ``` - `IMPORTANT` There is a bug in MLAPI at the moment that could prevent users from connecting to each other through editor! + IMPORTANT! There is a bug in MLAPI at the moment that could prevent users from connecting to each other through editor! ``` --- From d5b069bc48bae5c6c7e6c7c47e99ed90d66dffe3 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 16:44:34 +0100 Subject: [PATCH 07/13] docs: adjust main readme so that it points to our new Photon Setup guide --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dc697aac3..f8118d8c6 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,11 @@ After the build has completed you can launch several instances of the built exec In contrast to running a local setup, when playing over internet we don't neccessarily need a built executable. We can just run the game in editor. -Running the game over internet currently requires setting up a [Photon Transport for MLAPI](https://github.com/Unity-Technologies/mlapi-community-contributions), which uses Photon relay server to facilitate communication between clients and server living on different networks. +Running the game over internet currently requires setting up a [Photon Transport for MLAPI](https://github.com/Unity-Technologies/mlapi-community-contributions), which uses Photon relay server to facilitate communication between clients and server living on different networks. \ + +> Checkout our Photon-Realtime setup guide, here: +> ![here](Documentation/Photon-Realtime/Readme.md) + Alternatively you can use Port Forwarding. The wonderful https://portforward.com/ site has guides on how to enable port forwarding on a huge number of routers. BossRoom uses `UDP` and needs a `9998` external port to be open. From ee253ea1cbd0245654ad1edc573b491bbdd476e2 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 16:46:07 +0100 Subject: [PATCH 08/13] docs: adjust main readme so that it points to our new Photon Setup guide --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f8118d8c6..38e53482b 100644 --- a/README.md +++ b/README.md @@ -53,11 +53,10 @@ After the build has completed you can launch several instances of the built exec In contrast to running a local setup, when playing over internet we don't neccessarily need a built executable. We can just run the game in editor. -Running the game over internet currently requires setting up a [Photon Transport for MLAPI](https://github.com/Unity-Technologies/mlapi-community-contributions), which uses Photon relay server to facilitate communication between clients and server living on different networks. \ +Running the game over internet currently requires setting up a [Photon Transport for MLAPI](https://github.com/Unity-Technologies/mlapi-community-contributions), which uses Photon relay server to facilitate communication between clients and server living on different networks. > Checkout our Photon-Realtime setup guide, here: -> ![here](Documentation/Photon-Realtime/Readme.md) - +> [Boss Room Photon Setup Guide](Documentation/Photon-Realtime/Readme.md) Alternatively you can use Port Forwarding. The wonderful https://portforward.com/ site has guides on how to enable port forwarding on a huge number of routers. BossRoom uses `UDP` and needs a `9998` external port to be open. From dbe3f714814f163273ebc97c771f3b994bc8eb64 Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 18:57:05 +0100 Subject: [PATCH 09/13] Photon: re-add Photon App Settings --- Assets/Photon/Resources/PhotonAppSettings.asset | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 Assets/Photon/Resources/PhotonAppSettings.asset diff --git a/Assets/Photon/Resources/PhotonAppSettings.asset b/Assets/Photon/Resources/PhotonAppSettings.asset new file mode 100644 index 000000000..f09351165 --- /dev/null +++ b/Assets/Photon/Resources/PhotonAppSettings.asset @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c99169ab5731631db3a5a25d8124d31e473ca0ab2a0f052bd93f611a6090acbe +size 713 From e1caa208408bdaecff0ca33eb99a335cfe0031e9 Mon Sep 17 00:00:00 2001 From: Cosmin <38663153+Cosmin-B@users.noreply.github.com> Date: Mon, 29 Mar 2021 18:58:54 +0100 Subject: [PATCH 10/13] docs: updates Photon Realtime Readme from tech writers Co-authored-by: Lori Krell <76010626+lkrell@users.noreply.github.com> --- Documentation/Photon-Realtime/Readme.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/Documentation/Photon-Realtime/Readme.md b/Documentation/Photon-Realtime/Readme.md index 18d4ef24d..1d355d0ef 100644 --- a/Documentation/Photon-Realtime/Readme.md +++ b/Documentation/Photon-Realtime/Readme.md @@ -23,7 +23,12 @@ ## Playing Boss Room with friends -Once the setup is done, there are two ways you can actually test out is working, one way is to launch the Boss Room project via a packaged build or to use the Unity Editor, but do that with caution!. With that being said, both ways are almost the same in terms of how you host/join a session. +Once the setup is done, there are two ways you can actually test out is working: + +* Launch the Boss Room project using a packaged build. +* Use the Unity Editor, but do that with caution! + +With that being said, both ways are almost the same in terms of how you host or join a session. ``` IMPORTANT! There is a bug in MLAPI at the moment that could prevent users from connecting to each other through editor! @@ -69,4 +74,4 @@ If you want to Join a session then: 4. Click Join, and once successfully connected, now you should be in the Lobby with the rest of your friends . ![Images/Boss-Room-Lobby-Extra.png](Images/Boss-Room-Lobby-Extra.png) - \ No newline at end of file + From b6354baa07fac678c4ccb52c3e88ce1bb88dd777 Mon Sep 17 00:00:00 2001 From: Cosmin <38663153+Cosmin-B@users.noreply.github.com> Date: Mon, 29 Mar 2021 18:59:11 +0100 Subject: [PATCH 11/13] docs: updates Photon Realtime Readme from tech writers Co-authored-by: Lori Krell <76010626+lkrell@users.noreply.github.com> --- Documentation/Photon-Realtime/Readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/Photon-Realtime/Readme.md b/Documentation/Photon-Realtime/Readme.md index 1d355d0ef..bfa819c72 100644 --- a/Documentation/Photon-Realtime/Readme.md +++ b/Documentation/Photon-Realtime/Readme.md @@ -65,9 +65,9 @@ If you want to host a session then: --- If you want to Join a session then: -1. Click the Join Button and select `Relay Host` from the dropdown on the left +1. Click the Join Button and select `Relay Host` from the dropdown on the left. ![Images/Boss-Room-Join-Dropdown.png](Images/Boss-Room-Join-Dropdown.png) -2. You should be asked to input the room name below +2. You should be asked to input the room name below. ![Images/Boss-Room-Join.png](Images/Boss-Room-Join.png) 3. In this example, the room name is: `YQWOWS` From 42dbc095d4d313cff88e75c88cc29701bea97dab Mon Sep 17 00:00:00 2001 From: Cosmin <38663153+Cosmin-B@users.noreply.github.com> Date: Mon, 29 Mar 2021 19:00:38 +0100 Subject: [PATCH 12/13] docs: update Photon Realtime Readme from tech writers' suggestion Co-authored-by: Lori Krell <76010626+lkrell@users.noreply.github.com> --- Documentation/Photon-Realtime/Readme.md | 42 +++++++++++-------------- 1 file changed, 18 insertions(+), 24 deletions(-) diff --git a/Documentation/Photon-Realtime/Readme.md b/Documentation/Photon-Realtime/Readme.md index bfa819c72..f12d2ff00 100644 --- a/Documentation/Photon-Realtime/Readme.md +++ b/Documentation/Photon-Realtime/Readme.md @@ -1,25 +1,23 @@ -# Photon Setup Guide @Boss Room +# Photon Setup Guide for Boss Room ## Setup Photon -1. Access Wizard from Window → Photon Realtime → Wizard -2. Click next until you get to the Photon Cloud Setup Part -3. If you don't already have an account or an App Id, click on the Visit Dashboard button in order to create one - 1. If you just created an account for the first time you need to also create a New Application from Photon's Dashboard - 2. NOTE! The Photon Type for Boss Room is: `Photon Realtime` +1. Access the Wizard from Window → Photon Realtime → Wizard. +2. Click next through the wizard until you get to the Photon Cloud Setup. +3. If you do not already have an account or an App Id, click the Visit Dashboard button to create one. If you created a new account, create a New Application from Photon's Dashboard. + **Note:** The Photon Type for Boss Room is `Photon Realtime`. ![Images/Photon-App.png](Images/Photon-App.png) -4. Once an Application is setup, you will be able to get it's App ID from Photon's Dashboard, copy that to your clipboard - - NOTE! This App Id **must** be shared with other people in order to be able to connect to your Photon Room! +4. After the Application is setup, you can get its App ID from Photon's Dashboard. Copy the App ID to your clipboard. + + **Note:** This App Id **must** be shared with other people in order to be able to connect to your Photon Room. ![Images/Photon-App.png](Images/Photon-Dashboard.png) -5. Go back to the Photon Wizard Window of your Unity Project and paste the App Id there -6. Click on Setup - - It should show something like: "Your AppId is now applied to this Project **Done** " -7. Click on Next, then Done, you should be all setup now! -8. You can safely quit the Photon Wizard now! +5. In the Photon Wizard Window of your Unity Project, paste the App Id. +6. Click on Setup. You should receive a completion message, for example "Your AppId is now applied to this Project **Done**". +7. Click Next then Done. Setup is complete and you can safely quit the Photon Wizard. ## Playing Boss Room with friends @@ -30,15 +28,11 @@ Once the setup is done, there are two ways you can actually test out is working: With that being said, both ways are almost the same in terms of how you host or join a session. -``` - IMPORTANT! There is a bug in MLAPI at the moment that could prevent users from connecting to each other through editor! -``` ---- +> **IMPORTANT!** There is a bug in MLAPI at the moment that could prevent users from connecting to each other through the editor. -NOTE! Just to reiterate, it is very important that all Unity Editor users should have the exact same version of the project with no changes locally and their PhotonAppSettings should match with the Host's one. +> **Note:** To reiterate, it is important that all Unity Editor users have the exact same version of the project with no changes locally and their PhotonAppSettings should match with the Host's settings. ---- ### Hosting a Room @@ -46,8 +40,8 @@ NOTE! Just to reiterate, it is very important that all Unity Editor users should If you want to host a session then: -1. Click the Start button -2. Select `Relay Host` from the dropdown on the left +1. Click the Start button. +2. Select `Relay Host` from the dropdown on the left. ![Images/Boss-Room-Host-Dropdown.png](Images/Boss-Room-Host-Dropdown.png) 3. A random generated room name will be assigned. @@ -55,9 +49,9 @@ If you want to host a session then: 4. Share the generated room name with your users, and click confirm! -5. Done! You are now in the Lobby - also known as the Character Selection Screen, your friends/users should be able to join know. +5. Done! You are now in the Lobby - also known as the Character Selection Screen. Your friends/users should be able to join now. -- NOTE! You can see the Room Name, in the top-left corner! +> **Note:** You can see the Room Name in the top-left corner. ![Images/Boss-Room-Lobby.png](Images/Boss-Room-Lobby.png) ### Joining a Room @@ -72,6 +66,6 @@ If you want to Join a session then: 3. In this example, the room name is: `YQWOWS` -4. Click Join, and once successfully connected, now you should be in the Lobby with the rest of your friends . +4. Click Join. Once successfully connected, you should be in the Lobby with the rest of your friends. ![Images/Boss-Room-Lobby-Extra.png](Images/Boss-Room-Lobby-Extra.png) From fb993aabfaefbc306766c6461c7ed362c277d01b Mon Sep 17 00:00:00 2001 From: Cosmin Date: Mon, 29 Mar 2021 20:33:36 +0100 Subject: [PATCH 13/13] UI: PopupPanel replace ifdef directives with Application.isEditor --- .../BossRoom/Scripts/Client/UI/PopupPanel.cs | 24 +++++++++++-------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs b/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs index 2d0d354bf..b8db863e1 100644 --- a/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs +++ b/Assets/BossRoom/Scripts/Client/UI/PopupPanel.cs @@ -147,16 +147,20 @@ private void OnOnlineModeDropdownChanged(int value) { if (string.IsNullOrEmpty(PhotonAppSettings.Instance.AppSettings.AppIdRealtime)) { -#if UNITY_EDITOR - // If there is no photon app id set tell the user they need to install - SetupNotifierDisplay( - "Photon Realtime not Setup!", "Follow the instructions in the readme (/Documents/Photon-Realtime/Readme.md) " + - "to setup Photon Realtime and use relay mode.", false, true); -#else - // If there is no photon app id set tell the user they need to install - SetupNotifierDisplay( - "Photon Realtime not Setup!", "It needs to be setup in the Unity Editor for this project by following the Photon-Realtime guide, then rebuild the project and distribute it.", false, true); -#endif + if (Application.isEditor) + { + // If there is no photon app id set tell the user they need to install + SetupNotifierDisplay( + "Photon Realtime not Setup!", "Follow the instructions in the readme (/Documents/Photon-Realtime/Readme.md) " + + "to setup Photon Realtime and use relay mode.", false, true); + } + else + { + // If there is no photon app id set tell the user they need to install + SetupNotifierDisplay( + "Photon Realtime not Setup!", "It needs to be setup in the Unity Editor for this project " + + "by following the Photon-Realtime guide, then rebuild the project and distribute it.", false, true); + } return; }