https://github.com/flamendless/lovely-windows

Lovely-Windows is a simple Window/Screen Manager for Love2D
https://github.com/flamendless/lovely-windows

Last synced: about 2 months ago
JSON representation

Lovely-Windows is a simple Window/Screen Manager for Love2D

• Host: GitHub
• URL: https://github.com/flamendless/lovely-windows
• Owner: flamendless
• License: mit
• Created: 2017-06-05T16:19:13.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-09T14:39:30.000Z (almost 6 years ago)
• Last Synced: 2024-11-02T09:33:41.127Z (2 months ago)
• Language: Lua
• Size: 5.86 KB
• Stars: 16
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-love2d - lovely-windows - A Window/Screen Manager Module for virtual windows. (Helpers)

README

        
# LOVELY-WINDOWS is a window/screen manager for Love2D!

## FEATURES:

* Simple to use and implement

* Handles any keyboard input

* Timer to avoid repeating keypresses

* keypress/keyrelease - you choose what you want!

* Handles/calculates ratio of the game for scaling!

## You can also look at [sample](sample.lua)

## Love2d Forums [thread](https://love2d.org/forums/viewtopic.php?f=5&t=84009)

## BASIC USAGE:

1. Require the module,

```lua

WINDOWS = require("path-to-lovely-windows")

```

You can use any variable name if you don't like "WINDOWS"...Try using "MAC" *pun*

2. Make Tables! Key is the keyboard input, value is the width size

```lua

WINDOWS = require("path-to-lovely-windows")

local table = {

	f1 = {1024,720},

	f2 = {720,600}

}

--so if the user press f1, the new window size will be 1024x720

```

3. Initialize

```lua

function love.load()

	WINDOW.initialize(320,200) -- your custom game size (note: it is not the same as the window size)

	

	--then add the table to the module

	WINDOW.addInputTable(table) --parameters are the table we created earlier

end

```

4. Recognizing Inputs

```lua

function keypressed(key)

	WINDOW.keyInput(key)

end

--or if you want keyreleased, just put WINDOW.keyInput(key) in there.

```

# OTHER FUNCTIONS

## WINDOW.getRatio() - returns the calculated ratio, useful for using love.graphics.scale()

## WINDOW.listInput() - prints all the width and height sizes you've added. Useful with the LOVEDEBUG library

# TO-DO

* Add fullscreen switch

* Add joystick/gamepad input

## You can contribute, just make some pull request and commits. 

## Or you can issue if you have a problem

# LICENSE

This module/library is under the MIT license.