https://github.com/annulusgames/unityprogressbar
Simple and robust progress bar components for Unity uGUI.
https://github.com/annulusgames/unityprogressbar
progress-bar ugui ui ui-components unity
Last synced: 7 months ago
JSON representation
Simple and robust progress bar components for Unity uGUI.
- Host: GitHub
- URL: https://github.com/annulusgames/unityprogressbar
- Owner: annulusgames
- License: mit
- Created: 2024-02-24T05:01:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-06T11:20:31.000Z (over 1 year ago)
- Last Synced: 2025-03-02T03:24:16.474Z (7 months ago)
- Topics: progress-bar, ugui, ui, ui-components, unity
- Language: C#
- Homepage:
- Size: 382 KB
- Stars: 52
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unity Progress Bar
Simple and robust progress bar components for Unity uGUI.
[](LICENSE)
[](https://github.com/AnnulusGames/UnityProgressBar/releases)
[日本語版READMEはこちら](README_JA.md)
Unity Progress Bar is a library that adds a `ProgressBar` component to Unity UI (uGUI). It is designed to be simple and easy to use, avoiding unnecessary complexity, and allows for easy creation of custom progress bars by inheriting from `ProgressBarBase`.
## Setup
### Requirements
* Unity 2019.1 or later
* Unity UI 1.0.0 or later
### Installation
1. Open the Package Manager from Window > Package Manager.
2. Click the "+" button > Add package from git URL.
3. Enter the following URL:
```
https://github.com/AnnulusGames/UnityProgressBar.git?path=Assets/UnityProgressBar
```
Alternatively, open Packages/manifest.json and add the following to the dependencies block:
```json
{
"dependencies": {
"com.annulusgames.ugui-progress-bar": "https://github.com/AnnulusGames/UnityProgressBar.git?path=Assets/UnityProgressBar"
}
}
```
## Usage
Once Unity Progress Bar is installed, you can create a Progress Bar from the Create menu.
## Properties
| Property | Description |
| - | - |
| Min Value | Minimum value of the progress bar |
| Max Value | Maximum value of the progress bar |
| Value | Current value of the progress bar |
| Fill Mode | Specifies how the fill is displayed |
| Fill Image | (Only for FillMode.FillAmount) Image used for the fill portion |
| Fill Rect | (Only for FillMode.Stretch) RectTransform used for the fill portion |
| Direction | (Only for FillMode.Stretch) Direction in which the fill is stretched |
| On Value Changed | Event executed when the value changes |
## License
[MIT License](LICENSE)