libretro-chailove/README.md
2017-10-30 01:51:17 -04:00

2.1 KiB

ChaiLove Build Status platform libretro

Framework to make 2D games with ChaiScript and libretro/RetroArch.

ChaiLove Benchmark Screenshot

Games

Usage

ChaiLove is a libretro core, which can be run through RetroArch. To play Floppy Bird, run RetroArch and...

  1. Run RetroArch
  2. Download the ChaiLove core through RetroArch at Online UpdaterCore UpdatorChaiLove
  3. Download Floppy Bird through RetroArch at Online UpdaterContent DownloaderChaiLoveFloppy Bird
  4. Launch the game over through Load ContentDownloadsFloppy Bird.chailove

API

ChaiLove is roughly inspired by the LÖVE API. The following main.chai is a simple Hello World sample application:

global logo

def load() {
	logo = graphics.newImage("logo.png")
}

def draw() {
    graphics.print("Hello World!", 400, 300)
    graphics.draw(logo, 100, 100)
}

def update(delta) {
	// Change something on the screen.
}

To run it, execute the following:

retroarch -L chailove_libretro.so main.chai

Development

Building ChaiLove takes some time, so have patience. Use the following command to compile the core:

make

Testing

To compile and run the testing framework, use:

make examples

Flags

There are a few flags you can enable to change how Chai is compiled and used.

  • HAVE_CHAISCRIPT=0 Remove the scripting environment for fast compilation
  • HAVE_TESTS=1 Enables test/Test.cpp for testing
make HAVE_CHAISCRIPT=0 HAVE_TESTS=1