Skip to content

Commit

Permalink
Readme fix
Browse files Browse the repository at this point in the history
  • Loading branch information
risolvipro committed Dec 28, 2023
1 parent 45b1385 commit e083702
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,26 @@ Playdate Mode7 is a library designed to recreate the graphics mode known as "Mod

![demo](assets/demo.gif)

# Features
## Features

* Camera(s) with adjustable position, angle, tilt, FOV
* Customizable sprites
* Support to multiple displays (splitscreen)
* Functions to project a 3D point from the world onto the screen
* C and Lua support

# Lua setup
## Lua setup

The library has a simplified Lua setup:
* Locate the pre-compiled binaries for your platform in the *builds/[platform]* folder
* Copy the files (elf, dylib, dll) into the Source folder of the project
* Import the library: `import mode7`

# Assets
## Documentation

* [Lua API Documentation](https://risolvipro.github.io/playdate-mode7/Lua-API.html)
* [C API Documentation](https://risolvipro.github.io/playdate-mode7/C-API.html)

## Assets

The assets included in the demo (track-0, full-car) are part of [P-Racing](https://play.date/games/p-racing/), please don't use them in your final game.

0 comments on commit e083702

Please sign in to comment.