<h1 align="center">uPalette</h1>

Centrally manage colors and text styles in Unity projects.

<details> <summary>Details</summary>

Concept & Features
Setup
- Requirements
- Installation
Getting Started
Theme Feature Usage
Advanced Usage
Implemented Synchronizers
Technical details
- About the timing of reflecting Entries
How to update from version 1
Demo
Licenses

</details>

Concept & Features

In typical application development, one color is applied to multiple locations. The same blue color is applied to the button background, icon color, and outline in the following example.

Now think about changing this color from blue to green. In Unity, color values are serialized in Prefabs and Scenes, so we need to change all these values one by one.

This workload increases with the size of the project. With uPalette, such changes can be applied in batches by centralizing color management.

uPalette also allows you to manage text styles and gradients as well as colors.

In addition, the theme feature allows you to save a set of colors and text styles as a theme. By switching the active theme, you can reflect the colors and text style according to that theme.

Setup

Requirements

Unity2020.1 or higher.

Installation

インストールは以下の手順で行います。

Select Window > Package Manager in Unity Editor.
Select “+” Button > Add package from git URL .
Enter the following URL.
- https://github.com/Haruma-K/uPalette.git?path=/Assets/uPalette

If you want to install a specific version, add the version to the end of the URL as follows.

https://github.com/Haruma-K/uPalette.git?path=/Assets/uPalette#2.0.0

You can also update the version in the same manner as installation.

Note that if you get a message like No 'git' executable was found. Please install Git on your system and restart Unity, you need to set up Git on your machine.

Getting Started

Create Palette Store

To use uPalette, first open the Palette Editor from Window > uPalette > Palette Editor. You will see a window like as follows when you open the Palette Editor.

Next, create a Palette Store asset by clicking the center Create Palette Store button. Palette Store is the asset that will hold the data for the uPalette. You can place this anywhere in the project, but not in the Editor folder or Streaming Assets folder because this asset is used at runtime.

After creating a Palette Store asset, the Palette Editor will change to the following display.

Create Entry

In uPalette, color and character style settings are called Entries. You can add an Entry by pressing the “+” button in the upper right corner of the Palette Editor.

You can rename an Entry by clicking on its name. Entries can also be deleted by right-clicking menu of them.

You can also drag elements to reorder them.

Apply Entry

To apply the color and character style you created to components, select the target GameObject and press the Apply button for the target entry. The names of applicable components and properties will then be listed, and you can select the one you want to apply.

When multiple Synchronizers are implemented for the same component and property, the menu will display each Synchronizer name, allowing you to choose which Synchronizer to use.

This will synchronize the entries and properties. When the value of a synchronized Entry changed, the property is automatically rewritten.

At this time, a component named Synchronizer is attached to the target GameObject. You can change the target Entry from this Inspector. If you want to remove synchronization with the Entry, detach this component.

Note that When the Entry is applied to Prefab, It is not serialized in Prefab as in the normal Prefab workflow. You can serialize by right-clicking menu of Prefab.

Highlight synchronized GameObjects

Select Highlight from the Entry’s right-clicking menu to highlight (select) the synchronized GameObjects.

Handling non-color Entries.

Up to this point, I have described how to manage colors in uPalette. In addition to colors, there are other palette types in uPalette, such as gradients and character styles. You can switch between Palette types from the drop-down menu in the upper left corner of the Palette Editor.

Each drop-down menu is described below.

| Name | Description | | --- | --- | | Color | Use to manage color. | | Gradient | Use to manage gradient. | | Character Style | Use to manage character style of uGUI Text. | | Character Style TMP | Use to manage character style of Text Mesh Pro. |

Organizing Entries into Folders

You can organize entries into folders by separating entry names with slashes. When entries are organized into folders, they are displayed hierarchically in the Palette Editor as shown in the figure below.

<img width="70%" src="Documentation/folder_mode.png" alt="Folder Mode"> The setting to organize entries into folders can be changed from the following menu.

Project Set

UPalette

Install / Use

README

Table of Contents