Android setup for BossRoom #429

jilfranco-unity · 2021-12-16T16:57:17Z

Description (*)

This PR is the result of what has turned into a somewhat deep dive over a couple of weeks for getting BossRoom to run on Android. In the end, I've settled on adding things that the user would need to build for Android, while trying to keep overall project size and complexity down. This includes:

Setting up the scene geometry for baking (unity generated lightmaps, setting things to contribute to baked global illumination, setting up a light probe prefab that the user can turn on, setting up a baked lighting profile, adding turned off baked mode lights to the torch prefab that the player can use if they want to bake torch lights)
Setting up quality settings in the project and adding a button to the settings menu that can cycle through them
Setting up URP assets for all of the quality modes, especially for android
Also changing the scale of the geometry in the main menu, char select, and post game scenes to be 1 instead of 50-something, which both fixes this bug and makes the environment better for baking
Also also did a little bit of a reorganization on the different BossRoom geo prefabs, just some clean up to make it easier to select things in scene

By employing the things listed here, the user can get pretty decently performant builds on android. By messing with these settings, I was able to get 29 FPS on the Samsung J2 Core.

The overall idea is that these changes will give the user a good launching point to start with, covering some of the little nitty gritty things, then they can make more modifications if they'd like

Related Pull Requests

This PR was put on hold as I did a deeper dive into Android performance. This bug has been fixed in this PR due to the other changes I ended up making for performance. Probably not the best practice, but here we are :v

Issue Number(s) (*)

Jira ticket MTT-1068
Jira ticket MTT-1500

…was casued the intensity of the lights being set too high, the compounding render texture error was caused by the ssao being set to sample from depth and normals, setting it to just depth makes the error go away. Also modified low quality settings and added cheaper URP pipeline assets to be used with said low quality settings

…roid

…ser can use with their baked lighting, added lights to torches that are turned off, but good to be baked, reorganized the android urp assets, sanity checked and cleaned up quality settings, moved the quality button script to a better place (rather than assets folder), other tiny clean up things

… as setting up baked lights to be used by user for the char select background prefab

Assets/BossRoom/Scripts/Client/UI/QualityButton.cs

…aterial :v (thought it was a test shader i'd been working on and wanted to discard) so i've put it back and now the levels aren't completely pink

LPLafontaineB · 2021-12-17T21:51:07Z

Assets/BossRoom/Scripts/Client/UI/QualityButton.cs

+{
+    public class QualityButton : MonoBehaviour
+    {
+        public TMP_Text qualityBtnText;


~~Should be renamed to QualityBtnText~~
Edit: nevermind

Are you sure you're on the correct code style settings? Public variables are recommended as lowercase for me.

*Edited out code suggestion.

You're right, I got confused with properties.
However, could it be made private since it is not used outside this class?

Absolutely, good catch. Should be made private.

fernando-cortez

Looks good to me, besides some of the small comments I've made.

I also tested on my Pixel 3 and it's running a heck of a lot better than before, even on the High quality setting.

Also changing the scale of the geometry in the main menu, char select, and post game scenes to be 1

Amazing.

fernando-cortez · 2021-12-17T22:45:18Z

Assets/BossRoom/Scripts/Client/UI/QualityButton.cs

+{
+    public class QualityButton : MonoBehaviour
+    {
+        public TMP_Text qualityBtnText;


Are you sure you're on the correct code style settings? Public variables are recommended as lowercase for me.

*Edited out code suggestion.

Assets/StreamingAssets.meta

Packages/manifest.json

fernando-cortez · 2021-12-17T23:24:01Z

Another thing which jumped in my mind when reviewing this, which could be added to a follow-up PR or here if it's easy to implement, is that the camera in the main menu, post game scene (and char select too I believe?), can be consolidated into some sort of UICamera prefab.

It'll be nice to have those camera settings consistent across scenes that don't vary too much in what they render.

LPLafontaineB · 2021-12-23T16:49:52Z

The texture seems to be missing for broken pots and pillars

…prefabs, and settings are set up for baking, as well as geting a reorganization pass

jilfranco-unity · 2022-01-06T19:49:19Z

Another thing which jumped in my mind when reviewing this, which could be added to a follow-up PR or here if it's easy to implement, is that the camera in the main menu, post game scene (and char select too I believe?), can be consolidated into some sort of UICamera prefab.

It'll be nice to have those camera settings consistent across scenes that don't vary too much in what they render.

Definitely, I can do that in a separate PR right after this one

SamuelBellomo · 2022-01-06T21:05:21Z

ART_NOTES.md

+
+
+* You can hover over each setting and a tooltip will descirbe what it does <br /><br />


Suggested change

* You can hover over each setting and a tooltip will descirbe what it does <br /><br />

* You can hover over each setting and a tooltip will describe what it does <br /><br />

SamuelBellomo · 2022-01-06T21:08:55Z

ART_NOTES.md

@@ -0,0 +1,112 @@
+


Could we have a TLDR for say "Steps for Sam who wants to demo Boss Room" and "Steps for Sam when he wants to edit the scene"?

In other words, users like me could be pretty inexperienced with lighting and baking (and wouldn't want to start learning about this in a Netcode project...). So having concise instructions at the tope to get you where you want to go could be best.

Ahaha can do!

Can you and @s-omeilia-unity review this together?
I tried to create an iOS build for my low end iPhone device, but I was confused as to what I needed to do to make sure it was running smoothly.

Will read through this today!

SamuelBellomo · 2022-01-06T21:09:16Z

ART_NOTES.md

@@ -0,0 +1,112 @@
+
+# **Art Notes**
+


this doc should be linked to by the readme. People don't know we have other docs beside the readme

Speaking of docs, this md should reside in the Documentation folder

SamuelBellomo · 2022-01-06T21:12:33Z

Probably not the best practice, but here we are :v

which bad practices?

ART_NOTES.md

resolved with smart merge tool # Conflicts: # Assets/BossRoom/Scenes/BossRoom.unity

Assets/BossRoom/Scripts/Editor/BakingMenu.cs

Co-authored-by: Fernando Cortez <[email protected]>

LPLafontaineB

There are some of Fernando's comments left to address, but apart from that, LGTM

@jilfranco-unity

Cosmetic changes @jilfranco-unity

Co-authored-by: Fernando Cortez <[email protected]>

Changed baking menu to an abstract class, edited one of the console logs for baking menu to be more readable, deleted an unused include, changed quality text var to not be private

…om/Unity-Technologies/com.unity.multiplayer.samples.coop into bug/jil/bossroom-setup-for-android

SamuelBellomo · 2022-01-19T22:34:53Z

Documentation/ART_NOTES.md

@@ -0,0 +1,112 @@
+
+# **Art Notes**


There's two ART_NOTES files...
I'm guessing this one is the right one?

Oh weird, I'll delete the duplicate!

SamuelBellomo · 2022-01-20T14:54:17Z

Documentation/ART_NOTES.md

+![LightExplorer](Images/BossRoomMenu.png)
+
+* **To bake all lights:**
+  * Go to menu Boss Room > Lighting Setup > All Baked


Is there steps missing to require us to load all required scenes? Cause it's the kind of thing I'm sure I'll forget :P

I've moved a section detailing that from the bottom to the TLDR! :)

Deleted the extra art notes from root, changed some typed variables to vars, made the baking menu class public, edited the art notes to take baking for boss room section from bottom to the tldr

# Conflicts: # Assets/BossRoom/Scenes/BossRoom.unity

jilfranco-unity · 2022-01-21T15:36:21Z

Force pushed a new commit to overwrite a messed up one. Today I learned more about how git works :)

jilfranco-unity added 6 commits November 26, 2021 14:49

Merge branch 'develop' into bug/jil/graphics-issue-on-android

d50bb62

bossroom quality settings and testing different optimizations for and…

f90212d

…roid

merge develop in, all conflicts resolved with theirs

bcb4516

some clean up of old files that I mistakenly added back in :v as well…

031316b

… as setting up baked lights to be used by user for the char select background prefab

jilfranco-unity marked this pull request as ready for review December 16, 2021 17:16

jilfranco-unity requested a review from SamuelBellomo as a code owner December 16, 2021 17:16

jilfranco-unity requested review from LPLafontaineB and fernando-cortez December 16, 2021 17:17

jilfranco-unity changed the title ~~Bossroom setup for android~~ Android setup for BossRoom Dec 16, 2021

SamuelBellomo changed the base branch from develop to main December 16, 2021 18:43

SamuelBellomo changed the base branch from main to develop December 16, 2021 18:43

SamuelBellomo reviewed Dec 16, 2021

View reviewed changes

Assets/BossRoom/Scripts/Client/UI/QualityButton.cs Outdated Show resolved Hide resolved

Update Assets/BossRoom/Scripts/Client/UI/QualityButton.cs

7fa1b28

SamuelBellomo reviewed Dec 16, 2021

View reviewed changes

Assets/BossRoom/Scripts/Client/UI/QualityButton.cs Outdated Show resolved Hide resolved

SamuelBellomo and others added 2 commits December 16, 2021 13:47

Update Assets/BossRoom/Scripts/Client/UI/QualityButton.cs

1c21d22

this is gonna sound dumb but i accidentally deleted the environment m…

f8a9fb5

…aterial :v (thought it was a test shader i'd been working on and wanted to discard) so i've put it back and now the levels aren't completely pink

LPLafontaineB reviewed Dec 17, 2021

View reviewed changes

fernando-cortez reviewed Dec 17, 2021

View reviewed changes

jilfranco-unity added 2 commits January 6, 2022 13:53

ART_NOTES readme written for the baking process of bossroom! Scenes, …

989b7b2

…prefabs, and settings are set up for baking, as well as geting a reorganization pass

Merge branch 'develop' into bug/jil/bossroom-setup-for-android

9714fbe

SamuelBellomo reviewed Jan 6, 2022

View reviewed changes

ART_NOTES.md Outdated Show resolved Hide resolved

jilfranco-unity added 2 commits January 17, 2022 14:57

Modified a console log in baking script

cb838c8

Merge branch 'develop' into bug/jil/bossroom-setup-for-android

0c4c41f

resolved with smart merge tool # Conflicts: # Assets/BossRoom/Scenes/BossRoom.unity

fernando-cortez reviewed Jan 17, 2022

View reviewed changes

jilfranco-unity and others added 3 commits January 18, 2022 09:10

Update Assets/BossRoom/Scripts/Editor/BakingMenu.cs

af6ea73

Co-authored-by: Fernando Cortez <[email protected]>

Update Assets/BossRoom/Scripts/Editor/BakingMenu.cs

f684c68

Co-authored-by: Fernando Cortez <[email protected]>

Update Assets/BossRoom/Scripts/Editor/BakingMenu.cs

83f7132

Co-authored-by: Fernando Cortez <[email protected]>

LPLafontaineB reviewed Jan 18, 2022

View reviewed changes

Update ART_NOTES.md

7eaf840

Cosmetic changes @jilfranco-unity

s-omeilia-unity self-requested a review January 18, 2022 15:51

jilfranco-unity and others added 3 commits January 19, 2022 15:28

Update Assets/BossRoom/Scripts/Editor/BakingMenu.cs

266e52e

Co-authored-by: Fernando Cortez <[email protected]>

Addressed some comments from PR

43dafbc

Changed baking menu to an abstract class, edited one of the console logs for baking menu to be more readable, deleted an unused include, changed quality text var to not be private

Merge branch 'bug/jil/bossroom-setup-for-android' of https://github.c…

248f4bd

…om/Unity-Technologies/com.unity.multiplayer.samples.coop into bug/jil/bossroom-setup-for-android

jilfranco-unity requested review from SamuelBellomo, fernando-cortez and LPLafontaineB January 19, 2022 20:52

LPLafontaineB previously approved these changes Jan 19, 2022

View reviewed changes

SamuelBellomo reviewed Jan 19, 2022

View reviewed changes

SamuelBellomo reviewed Jan 20, 2022

View reviewed changes

Deleted extra art notes, addressed comments from PR, edited art notes

d4095b4

Deleted the extra art notes from root, changed some typed variables to vars, made the baking menu class public, edited the art notes to take baking for boss room section from bottom to the tldr

jilfranco-unity dismissed LPLafontaineB’s stale review via d4095b4 January 20, 2022 21:01

Deleted an extra white line

d3e4145

jilfranco-unity requested review from SamuelBellomo and LPLafontaineB January 21, 2022 15:05

Merge branch 'develop' into bug/jil/bossroom-setup-for-android

7583cda

# Conflicts: # Assets/BossRoom/Scenes/BossRoom.unity

jilfranco-unity force-pushed the bug/jil/bossroom-setup-for-android branch from 69057c5 to 7583cda Compare January 21, 2022 15:26

LPLafontaineB approved these changes Jan 21, 2022

View reviewed changes

fernando-cortez approved these changes Jan 21, 2022

View reviewed changes

jilfranco-unity merged commit 5c8c6de into develop Jan 24, 2022

jilfranco-unity deleted the bug/jil/bossroom-setup-for-android branch January 24, 2022 14:17



		* You can hover over each setting and a tooltip will descirbe what it does <br /><br />

Android setup for BossRoom #429

Android setup for BossRoom #429

Uh oh!

Conversation

jilfranco-unity commented Dec 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Issue Number(s) (*)

Uh oh!

Uh oh!

Uh oh!

LPLafontaineB Dec 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fernando-cortez Dec 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fernando-cortez left a comment

Choose a reason for hiding this comment

Uh oh!

fernando-cortez Dec 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fernando-cortez commented Dec 17, 2021

Uh oh!

LPLafontaineB commented Dec 23, 2021

Uh oh!

jilfranco-unity commented Jan 6, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamuelBellomo commented Jan 6, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LPLafontaineB left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jilfranco-unity commented Jan 21, 2022

Uh oh!

Uh oh!

jilfranco-unity commented Dec 16, 2021 •

edited

Loading

LPLafontaineB Dec 17, 2021 •

edited

Loading

fernando-cortez Dec 17, 2021 •

edited

Loading

fernando-cortez Dec 17, 2021 •

edited

Loading