Skip to content

Get started

Before you start#

This engine was built for Linux, but it should work on MacOS and Windows.

MacOS#

Windows#

You can find some pre-built tools in the tools/winfolder.

  • cdi4dc + mkisofs can make .CDI files (Run makeCDI.bat)
  • genromfs generates romdisks

Install#

  1. Download the engine from itch.io and decompress it somewhere on your computer.
  2. Run make dependency to install theses tools:
    • mkdcdisc
    • lxdream-nitro
    • love2d
    • dc-tools
    • texconv
  3. Make a new game using make new NAME=game_name. Don’t forget to add the game to the config.lua file.

Configure#

Config.lua holds some configuration for the engine.
This is where you define the games you want to load.

local config = {

    games = {
        {dir="game_example", name="Example"},
        {dir="game_tower",   name="Tower"},
    },

    -- Default game to load
    defaultGame = "Example",

    -- console output - disable this is you get slowdown using BBA or Serial.
    console = true,

    -- Path for lackages, libraries. The require function.
    -- Don't forget to add a semicolom at the end. ' ; '
    reqPath = "lua/?.lua;" .. "lua/lib/?.lua;",
}

-- This isn't part of the config table but it's a good place to put the CDDA songs.
-- With this global table you'll be able to access the songs from any game.
-- And ensure compatibility with the LOVE2D renderer.
CDDA = {
    song1     = {id = 1, file = "1-song.wav"},
    titleSong = {id = 2, file = "2-title.wav"},
}


return config

Run your game#

Build romdisk#

Generate romdisk from every folder prefixed with rd_ (rd_assets, rd_level1) in a game folder. make romdisk

Broadband Adapter (BBA)#

Edit your BBA IP address in the Makefile then make bba

Serial Adapter#

Edit your serial port in the Makefile then make serial

Emulator#

Make sure you have installed the dependencies then make cdi emulator

Love2D#

You can test your game on PC using make love