Quick Start

This guide will walk you through creating and running a new Love2D project with Kaledis.

1. Initialize a Project

Open your terminal and run the initialization command:

kaledis init

The strict interactive CLI will guide you through the setup:

1. Project Name: Enter a name for your project (e.g., my-game).
2. Love Execution: Kaledis will try to find love.exe. If it fails, you’ll be moved to provide the path manually (e.g., C:\Program Files\LOVE).
3. Module Detection: Choose between manual (select specific standard modules) or automatic (detects used modules).
4. Pesde: Choose whether to use Pesde for package management (Recommended).
5. Folders: Choose whether to generate src and assets folders.

Once completed, Kaledis will generate the project structure for you.

2. Project Structure

A typical Kaledis project looks like this:

my-game/
├── .vscode/            # VSCode settings (integrations)
├── assets/             # Game assets (images, sounds, etc.)
├── luau_packages/      # Dependencies (if Pesde is used)
├── src/
│   └── main.luau       # Main entry point
├── kaledis.toml        # Project configuration
├── pesde.toml          # Package configuration (if Pesde is used)
└── .gitignore

3. Writing Code

Open src/main.luau. You can write standard Love2D code using Luau syntax.

function love.draw()
    love.graphics.print("Hello from Kaledis!", 400, 300)
end

4. Running the Game

Start the development server with:

kaledis dev

This command will:

1. Transpile your Luau code to Lua.
2. Bundle your project.
3. Launch Love2D.
4. Watch for file changes and auto-reload (if configured).

5. Building for Distribution

To package your game into a .love file:

kaledis build

This creates a build in the .build or dist directory, ready to be shared or run with Love2D.

If you want to see more examples you can look at the examples folder, there i test a bunch of features of kaledis