/escape-from-valis

A quick little rogue-like game made with LÖVE.

Primary LanguageLuaMIT LicenseMIT

Escape from Valis

CircleCI

A quick little rogue-like game made with LÖVE.

Install

macOS

brew install --cask love love ./ at the base directory of this repository

Windows 11

Install love2d from the website, then run the following in Powershell (using the default install directory):

Set-Alias lovec 'C:\Program Files\LOVE\lovec.exe'

Then change the directory to the project root, and run:

lovec .

Notes

Levels and rooms

Each "level" represents, as you might expect, a level in the game. These levels are numbered, starting at level 1. Each level can contain many rooms, at least MIN_ROOMS and up to (and including) MAX_ROOMS (those constants are defined in mod/constants.lua).

In turn, each room will have a width and height between certain constraints, also defined in that constants file. The room will be bound by walls, and may have 1 to 4 "doors", really just openings leading to a path between rooms.

Much of this is still in flux, so stay tuned!

Testing

We use busted for testing. These tests are limited to the spritely module, at least for now.

You can install busted from luarocks, and run the tests locally if you like, in your terminal, with luarocks install busted.

Then you'll be able to run busted as a binary in the project root to run all the files matching spec/**/*_spec.lua. These tests will run automatically using CircleCI on every PR.

Credits

This game was made by:

License

This game is released under the MIT license. See the LICENSE file for details.