Please go through this document to understand how Muk works.
Download TMP and DOTween. #
If you don’t have TMP, simply right-click in Hierarchy > UI > Text – TextMashPro. It will guide you to install TMP.
If you don’t have DOTween, go to the DOTween unity asset store page, download, and install it. DOTWeen provides both free and paid versions. You can choose whichever version you prefer.
URP Setting (URP Only) #
* if you are using built-in Render pipeline, you can skip this part.
For iOS, few Muk components use the blur effect. For blur to work in URP, you will need to add a renderer feature to the URP renderer.
Go to Project > settings > select the renderer data you want to support in the project. Click the Add Renderer Feature button and select UI Blur Render Pass Feature.
Adding Muk App Manager to the scene. #
For Muk Components to work, you will need to have Muk App Manager in the scene. Right-click in Hierarchy > Muk > Muk App Manager. The Muk App manager will handle everything for you. Muk App Manager will not get destroyed when loading a new scene, so you don’t need to add it to all the scenes, just add it to the first scene.
For development purposes, you can temporarily add the manager to the scene that you are working on. But remember to remove the manager from all the scene and add it to the first scene only when releasing the app.
Adding Muk Components to the scene #
Finally the great part – how to add muk components into your scene.
Since Muk uses Unity UI. You can work with Muk as you would work with Unity UI.
You can simply right click in the Hierarchy > Muk and select whatever Muk Components you want to add to your scene.
And now you can edit the Muk-Component values to make it look like however you want. Please go through Muk Components sections in this documents to understand how each Muk component works.
App Data / App Theme #
App Data #
You can set the platform type(iOS / Material design) or dark mode inside Muk App Data. Go to Project > Muk > MukSetting > MukAppData and select MukAppData. You can change the platform type, dark mode and other app settting in the Inspector window. You will see the changes immediately. For details please go through Muk App Data section.
You can change the app’s look and feel by simply changing the value in MukAppTheme. Go to Project > Muk > MukSetting > MukThemeData > _DefaultTheme. You can change the iOS theme in iOSDefaultTheme, and the material design theme in MaterialDefaultTheme. For details please go through the Muk App Theme section.
* Note that the MukAppData and MukThemeData values are universal, so when you change it, it will affect all the Muk components.