module Lapis::Docs::B_LAPIS_CLI_AND_TOOLCHAIN::I_PACKAGING_AND_DISTRIBUTION

Overview

Packaging & Release Distribution

Comprehensive guide to exporting and packaging your finished game or redistributable addon with lapis package.

Executive Summary & Key Topics

Topic	Method / Anchor	Description
Distribution Formats	`.topic_00_package_formats`	Supported export targets: game, addon, installer, deb, and full release.
lapis package game: Standalone Export	`.topic_01_package_game`	Bundling a playable game executable for Windows, Linux, or macOS.
lapis package installer: Windows Setup	`.topic_02_windows_installer`	Compiling an Inno Setup installer executable with Crystalline and desktop shortcuts.
lapis package deb: Linux Distribution	`.topic_03_debian_package`	Generating a signed, standard .deb package for Debian, Ubuntu, and Mint.

Related Guides & Source References

Package Command: tools/lapis/src/commands/package.cr
Installer Script: rsrc/installer/lapis_installer.iss
Live Spec: tools/lapis/spec/commands/package_spec.cr

Defined in:

libgodot/docs/b_lapis_cli_and_toolchain/i_packaging_and_distribution.cr

Class Method Summary

.topic_00_package_formats : Nil
Distribution Formats: Supported export targets: game, addon, installer, deb, and full release.
.topic_01_package_game : Nil
lapis package game: Standalone Export: Bundling a playable game executable for Windows, Linux, or macOS.
.topic_02_windows_installer : Nil
lapis package installer: Windows Setup: Compiling an Inno Setup installer executable with Crystalline and desktop shortcuts.
.topic_03_debian_package : Nil
lapis package deb: Linux Distribution: Generating a signed, standard .deb package for Debian, Ubuntu, and Mint.

Class Method Detail

def self.topic_00_package_formats : Nil #

Distribution Formats: Supported export targets: game, addon, installer, deb, and full release.

Key Topics & Information

Playable Game: lapis package game (self-contained executable + embedded PCK)
Addon Zip: lapis package addon (clean redistributable archive for AssetLib)
Windows Installer: lapis package installer (Inno Setup executable)
Debian Package: lapis package deb (.deb for Ubuntu/Debian)
Release Distribution: lapis package release (full distribution archives + SHA256)

def self.topic_01_package_game : Nil #

lapis package game: Standalone Export: Bundling a playable game executable for Windows, Linux, or macOS.

To package your game into a single playable bundle:

lapis package game [options]

Options:

Option	Shorthand	Description
`--release`	`-r`	Builds with release optimizations and strips debug symbols
`--embedded`		Embeds game PCK data directly into the executable binary
`--output=DIR`	`-o`	Destination directory (default: `dist/`)
`--force`	`-f`	Overwrite existing distribution files

def self.topic_02_windows_installer : Nil #

lapis package installer: Windows Setup: Compiling an Inno Setup installer executable with Crystalline and desktop shortcuts.

If you are distributing tooling or a complete development suite on Windows:

lapis package installer

Compiles lapis-setup-windows-x86_64.exe using Inno Setup (ISCC.exe), bundling the lapis executable, Crystalline LSP, runtime dependencies (gc.dll, pcre2-8.dll, iconv-2.dll), and configuring user PATH.

def self.topic_03_debian_package : Nil #

lapis package deb: Linux Distribution: Generating a signed, standard .deb package for Debian, Ubuntu, and Mint.

On Linux, generate a standard .deb archive:

lapis package deb

Stages the binary into /usr/bin/lapis, configures man pages, and sets up package control metadata in bin/release_dist/.