| docs | ||
| elements | ||
| extensions | ||
| images | ||
| lib | ||
| screenshots | ||
| spec | ||
| .gitignore | ||
| .gitmodules | ||
| build.sh | ||
| config.ld | ||
| Element.luadoc | ||
| init.lua | ||
| init.moon | ||
| LICENSE.txt | ||
| main.lua | ||
| main.moon | ||
| README.md | ||
| todo.txt | ||
| util.lua | ||
| util.moon | ||
Pop.Box
Do not mix with Cola.
Pop.Box is a GUI library for use in the LÖVE engine, designed to be easy to use and require as little code as possible to set up. It is primarily designed to make it easy to experiment with GUIs during development.
Supports LÖVE versions 0.9.1 and higher.
Documentation
Building the documentation relies on a specific version of LDoc. Run
sudo luarocks install ldoc 1.4.4-1 to install the necessary version.
Note: Currently rewriting and redesigning Pop.Box. The following info is out of date until I finish:
Features
- Quickly set up and align GUI elements.
- Fully customizable alignment / styling.
- Moving/resizing elements takes alignment into account.
- Mouse and key input handling. (Note: Work in progress.)
- Extensible: Make your own elements, skins, extensions, and everything is automatically loaded.
Usage
The basics:
local pop = require "pop"
-- define LÖVE callbacks here (update, draw, textinput, mouse/key events)
local window = pop.window():align("center"):setTitle("Welcome!")
window:addChild(pop.text("Welcome to Pop.Box()!"))
Note: Due to this being so early in development...the above example doesn't
actually work as expected. window is a very new element.
For more examples, see the code in demo. For documentation, see docs (and
links to documentation below).
Documentation
Note: Docs are a work in progress, sometimes lagging behind the actual code.
- Pop Module (The main module/interface.)
- Elements (Basic features of elements/types of elements.)
- Skins (A basic system for quickly applying settings to many elements.)
- Extensions (A way to load custom code in.)
- Drawables (Reference for what can be used as a background/color.)