tangent/Pop.Box
1
0
Fork 0
mirror of https://github.com/TangentFoxy/Pop.Box.git synced 2024-10-18 08:14:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
(ON HOLD) Pop.Box is an easy to use GUI library for the LÖVE engine, intended for rapid prototyping.
66 Commits 6 Branches 0 Tags 2.4 MiB
MoonScript 58.3%
Lua 41.5%
Shell 0.2%
37a2cc125b
Go to file
Paul Liverman III 37a2cc125b lots of docs n stuff woo!
2016-08-21 00:49:16 -07:00
docs lots of docs n stuff woo! 2016-08-21 00:49:16 -07:00
elements lots of docs n stuff woo! 2016-08-21 00:49:16 -07:00
screenshots videos working! 2016-04-17 18:45:18 -07:00
spec fix #46 #47 docs + busted 2016-08-20 22:29:16 -07:00
.gitignore fix #46 #47 docs + busted 2016-08-20 22:29:16 -07:00
config.ld lots of docs n stuff woo! 2016-08-21 00:49:16 -07:00
Element.luadoc lots of docs n stuff woo! 2016-08-21 00:49:16 -07:00
init.lua lots of docs n stuff woo! 2016-08-21 00:49:16 -07:00
init.moon lots of docs n stuff woo! 2016-08-21 00:49:16 -07:00
LICENSE.txt added MIT license 2016-04-03 11:48:03 -07:00
main.lua fix #46 #47 docs + busted 2016-08-20 22:29:16 -07:00
main.moon fix #46 #47 docs + busted 2016-08-20 22:29:16 -07:00
README.md wip rewrite bare-bones / using ldoc 2016-06-20 22:52:44 -07:00
todo.txt mostly done re-implementing things I think 2016-02-22 22:10:13 -08:00
util.lua compiled! 2016-06-21 12:32:58 -07:00
util.moon lots of docs n stuff woo! 2016-08-21 00:49:16 -07:00

README.md

Pop.Box

Do not mix with Cola.

GitHub release GitHub downloads GitHub issues GitHub license

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.

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.)