Skip to content

thelastpointer/tlp.ui

Repository files navigation

TLP.UI

What

This is a very simple window manager for your Unity3d project. Use it if you need a low-complexity GUI.

It's main features:

  • Very simple -- a few scripts, basic features only; comes with readily usable prefabs.
  • No dependencies.
  • A simple window stack -- only one window can be active at a time.
  • Tabs.
  • The most neccessary modal dialogs:
    • Simple message
    • Error message
    • Yes/no dialog
    • Text prompt
    • Progress dialogs

Additionally:

  • Window animations -- nothing too fancy, just enough to make it look good.
  • Window showing and hiding is thread-safe.
  • Sounds -- optionally whoosh and boink and clack and bzzzt
  • Options for controller navigation.

Why

For a lot of projects -- especially if you have a lot of prototypes -- you need to create some GUI features over and over again. I got tired of this, so I made this library to help with common tasks. You can set this up and display menus and error messages when prototyping.

How

This is intended to be a git submodule, but frankly, git sucks and submodules are even worse, so just clone/download the repo and copy the files into your project.

I included examples for everything and it fits into a single scene easily. Check that out. A detailed explanation is in details.md.

Who

Website: https://thelastpointer.github.io/

I'm on twitter as @thelastpointer if you'd like to chat!

Tell me if you like it or hate it, if you have bugfixes or ideas. Please keep in mind that I'd like to keep this as simple as possible.

License

MIT -- if you extend it and release the source, credit this project so we can help each other. I won't come after you if you don't.

TODO

There are still a couple of things I want to do:

  • Text prompt might need a character validation callback for passwords
  • Message boxes need to be thread-safe too!
  • Message boxes are weird, a lot of things need to be renamed
  • A submodule how-to document
  • In-code documentation :P
  • Message box transitions
  • Move transitions into their own struct
  • Controller support:
    • Auto-select first control
    • Window next/prev controls somehow (custom Input button?)
    • Tabs next/prev controls
    • Document all this

About

A simple UI library for Unity3d.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages