Unity UI Framework

Get Started · Usage · Roadmap · Report Bug

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

Unity UI Framework was created to rapidly speed up development of new projects. It does this by including several essential manager classes, well structuered project file organisation and a fully featured MainMenu with sample scene. Full feature list below.

Feature List:

• Manager classes include; Audio, Level, DataPersistence & MainMenuUI.
• Well structured project files with accompanying documentation to keep everything tidy.inp
• Fully featured Main Menu UI that includes; Home, Video, Audio & Controls screens. (Built using Unity's UI Toolkit)
• Data serialisation & deserialisation for settings logged using JSON.
• Documentation provided allows for easy modifications & extendability.
• Good performance

There are more features planned, for more information please check the Roadmap

(back to top)

Built With

• 
• 

(back to top)

Getting Started

Follow the instructions below to get started:

Prerequisites

Make sure you have installed Unity 2022.3+ to your Unity Hub. This project was created using 2022.3.10f1, at the time of writing this is the official 2022 LTS version.

Installation

1. Clone the repo

   git clone https://github.com/jezzergt/Unity-UI-Framework.git

2. Unity Hub - Add project from disk, selecting the newly cloned project directory

3. Rename Project the project to whatever you like by renaming the root folder

4. Launch the project via Unity's Hub.

(back to top)

Usage

Documentation

(back to top)

Roadmap

• Add Changelog
• Improve Documentation
• Main Menu Navigation With Keyboard
• Main Menu Navigation With Gamepad
• Separate Controls Section For Gamepad
• Improved UI Animations
• New Game Difficulty/Game Modes Screen
• Load Game Screen
• Asynchronous Loading Screen
• In-game Pause Screen

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License.

(back to top)

Contact

Jeremy GT - jeremy.gt@outlook.com

Project Link: [https://github.com/jezzergt/Unity-UI-Framework]

(back to top)

Acknowledgments

• MainMenu Back Icon - Go back icons created by Freepik - Flaticon
• MainMenu Background Image - https://wallpapercave.com/u/payers88
• MainMenu Background Music - 'Within Our Nature' by Scott Buckley - released under CC-BY 4.0. https://www.scottbuckley.com.au
• MainMenu UI Sound Effects - JDSherbert https://jdsherbert.itch.io/ultimate-ui-sfx-pack
• Awesome Template - https://github.com/othneildrew/Best-README-Template

(back to top)