https://github.com/beforan/steamy-windows

A keyboard driven Message Window / Windowed UI library for LOVE. Suitable for JRPGs.
https://github.com/beforan/steamy-windows

Last synced: about 1 month ago
JSON representation

A keyboard driven Message Window / Windowed UI library for LOVE. Suitable for JRPGs.

• Host: GitHub
• URL: https://github.com/beforan/steamy-windows
• Owner: beforan
• License: mit
• Created: 2015-07-31T09:52:58.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-04T11:20:01.000Z (almost 7 years ago)
• Last Synced: 2023-02-28T00:23:07.839Z (almost 2 years ago)
• Language: Lua
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Steamy Windows

A keyboard / joypad driven Message Window / Windowed UI library for LÖVE. Suitable for JRPGs.

## What is it good for?

Right now not much. you could use it for some Text-in-a-box UI,

without having to handle sizing / wrapping / centering etc. yourself

Note that currently there is no input handling (no dismissing a focused window, for example) so you need to do that yourself.

As it grows, it should be usable for:

- Simple UI windows

- JRPG-style Speech windows (with buttons to proceed / dismiss)

- Windows containing buttons, navigable by keys or joypad

- Entire JRPG style Menus, with windows and buttons navigable by keys or joypad

- Complex layout containers for multiple types of content within windows

- Configurable defaults

- Configurable Styles

It is never planned to be mouse controllable.

## How do I use it?

You need to use it in a project targeting LÖVE  `0.9.0+`

```lua

-- require the Window "class"

local Window = require "path/to/window.lua"

-- create some windows

local windows = {}

function love.load()

	table.insert(windows, Window { content = "hello!" })

	table.insert(windows, Window {

		top = 200,

		left = 300,

		content = "goodbye!"

	})

end

-- draw the windows

function love.draw()

	for _, window in ipairs(windows) do

		window:draw()

	end

end

```

Windows have a number of default properties that can be overridden by specifying them in the table passed to `Window()`:

Property | Description

:-------:|:------------

`top` | Sets the window's **top edge** position on the y-axis of the screen

`left` | Sets the window's **left edge** position on the x-axis of the screen

`x` | Alternative to `left` (`left` overrides `x` if specified). Sets the window's **centre** position on the x-axis of the screen

`y` | Alternative to `top` (`top` overrides `y` if specified). Sets the window's **centre** position on the y-axis of the screen

`width` | the width of the window (default `150`)

`height` | the height of the window (default `50`)

`autosize` | Ask the window to set its `width` and `height` based on fitting its `content` (overrides `width`/`height` values if specified)

`maxwidth` | The maximum `width` of an `autosize` window: text wrapping is forced if the `content` requires a window wider than this

`content` | a `string` or `number` to display inside the window

`defaultFont` | The LÖVE `Font` object used to render the `content` in this window

`defaultAlign` | `"left"`, `"center"` or `"right"` alignment for the window `content`

`contentMargin` | The margin inside the window, around the `content` (i.e. distance from window edge to content container edge) (default `10`)

That's it for now.