lovedos/README.md

LoveDOS

A framework for making 2D DOS games in Lua. LoveDOS provides an API based on a subset of the LÖVE API.

Getting started

You can download LoveDOS from the releases page. If you're not using DOS as your operating system then DOSbox can be used to emulate a DOS computer.

When you run love.exe it searches for a file named "main.lua" in its current folder; the code in "main.lua" is then loaded and executed. A small example program which displays white text on a black background and exits when the escape key is pressed is as follows:

function love.draw()
  love.graphics.print('Hello World!', 20, 20)
end

function love.keypressed(key)
  if key == "escape" then
    os.exit()
  end
end

The doc/api.md file provides a reference and overview of all of the built-in LoveDOS modules, functions and callbacks.

Building

Instructions for building the project from source can be found in the doc/building.md file. If you intend to make changes to the project then an overview of each source file's content can be found in doc/files.md.

License

This library is free software; you can redistribute it and/or modify it under the terms of the MIT license. See LICENSE for details.

LoveDOS includes Lua (MIT license). The full license for Lua can be found at the bottom of the src/lib/lua/lua.h file.