Skip to content

Latest commit

 

History

History
73 lines (43 loc) · 6.57 KB

index.md

File metadata and controls

73 lines (43 loc) · 6.57 KB

Whether you like it or not, the time has come for us designers to design in context of a notch and embrace it instead of hiding it. This tool also enables design-time preview which help you iterate your design without building the game.

Main screenshot

  • Components to attach to your GameObject, they will stay safe by staying inside safeArea and out of the way of any cutouts.
  • Notch Simulator to iterate your design in editor with various devices available. See the components react immediately without building the game or access to real devices.

Donations accepted : Ways to pay for this software

This software is an open sourced donationware, which complies with Unity's Asset Store Provider Agreement, section 4.9. You can use it first, then if it is truly benefitting to your project or saved days and weeks of your time, you should pay for this software to keep the development alive.

  • Have Unity assets in return : You can purchase my other products in my publisher page.
  • One time or recurring contribution with exposure : Repository with over 100 stars could start an Open Collective. Contributors are listed on that page, and potentially could be shown in the homepage and GitHub page later. If you think that's cool, it is a nice option.
  • You want to just donate directly to me : I have PayPal.me and Ko-fi set up.

Sincerely, thank you! - Sirawat Pitaksarit / 5argon

Requirements

  • Minimum Unity version 2019.1, supports safeArea based components. Components that uses cutouts do nothing.
  • Unity version 2019.2+, additionally supports cutouts based components. (None yet, in developement.)
  • Unity version 2019.3+, additionally supports integration with Device Simulator.
  • Your game's Android player has to use high enough Android version to report useful safeArea/cutouts information to Unity. Otherwise the components will not help avoiding the notches.

Getting started

1. Install

  • Using the Asset Store version, install and update using the usual way. Soon Unity Package Manager (UPM) will be able to go directly to Asset Store. After installed you can also take the package out of project and use local UPM feature to link to package.json, freeing your Assets folder from things that aren't your game.

  • You can pull from GitHub's master branch with UPM's Git functionality. Add the line below to your manifest.json :

    "com.e7.notch-solution": "git://github.com/5argon/NotchSolution.git",

    However it will not update automatically when I push fixes to this repo. You must remove the lock line that appears in you manifest.json file to refetch.

The package is properly "UPM shaped" with assembly definition files. If you also use one, the name of an assembly to link is E7.NotchSolution (GUID : 06dd7692457a446f7a9de9613998f95d). C# namespace is also E7.NotchSolution if you want to extend the built-in components.

2. Use the components, iterate with the simulator

Learn available components and use them in your design. Use Notch Simulator to validate the design instantly.

You can also see the how-to section for some tricks and recipes.

3. Set the Project Settings before you build

enable rendering into cutout

All the work for this moment. Enable Render outside safe area under Resolution and Presentation for Android. Otherwise you get black bars.

For iOS, I think there is no option to do black bar as Apple discourages and may denies app that tries to hide the notch, therefore it already renders outside the safe area.

4. License

The license is MIT. You should do your part in the open source software movement.

See Notch Solution in action

I have in fact dogfood my own plugin so you don't have to worry much if the support for the package dies out because of "no demand", I demand it myself. The same goes to my other products.

The game is called Duel Otters which is free. Notch Solution is especially important in this game since it is a 2-player game where the other player will have to be on the notched side. Try it with various devices and see the UI adapts!

It's open source

At first I am going to make it a normal Asset Store package like my other works. But I realized that this is the first one that is not so niche in its use and could have widespread benefits to many, and as an open source that effect could be multiplied greatly. I only see notched devices increasing in the recent year.

I am not sure if I could come up with an another package with this potential, so I decided to take this opportunity for the first time. There is really no strings attached if that is what you were worrying. What I get by doing this?

  • Screen cutout problems can be solved collaboratively. With so many devices in the world the problem space is HUGE. I think there are many variations and potentially different permutation of problems that bound to happen later. Over time, having more inputs from users together we could make this more stable than I could ever made alone.
  • I got to proof I have open source development experience added to my portfolio and my publisher page. It says something differently about me than before.
  • I get exposure to my other products, where you can expect similar quality and code discipline to Notch Solution.
  • It is not necessary a bad financial/business move. The author of the popular Odin Inspector has open sourced their Odin Serializer with good reasons. More often than not, it also shows that they are capable of writing quality code.