Smaug

Smaug is a tool to manage your DragonRuby Game Toolkit projects.

Installation

Manual Installation

You can download the latest version from the release page.

Linux

Arch Linux

Smaug is on the AUR.

Mac

Install with homebrew.

brew tap ereborstudios/tap
brew install smaug

Windows

Install with scoop.

scoop bucket add ereborstudios https://github.com/ereborstudios/scoop-bucket.git
scoop install smaug

Other Operating Systems

We do not maintain packages for any other operating systems. You can use Cargo as a package manager.

1. Install rust through your package manager or with rustup
2. Run cargo install smaug-bin

Usage

smaug 0.4.0
Matt Pruitt <matt@guitsaru.com>
Create games and share packages with the DragonRuby community

USAGE:
    smaug.exe [FLAGS] <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
        --json       Returns JSON
    -q, --quiet      Silence all output
    -v, --verbose    Displays more information
    -V, --version    Prints version information

SUBCOMMANDS:
    add           Add a dependency to Smaug.toml
    bind          Create bindings for c extensions (Pro only)
    build         Builds your DragonRuby project.
    config        Displays your current project's Smaug configuration
    docs          Opens DragonRuby docs in your web browser
    dragonruby    Manages your local DragonRuby installation.
    help          Prints this message or the help of the given subcommand(s)
    init          Initializes an existing project as a Smaug project.
    install       Installs dependencies from Smaug.toml.
    new           Start a new DragonRuby project
    package       Manages your DragonRuby package.
    publish       Publish your DragonRuby project to Itch.io
    run           Runs your DragonRuby project.

Starting a new DragonRuby project

1. Download a copy of the DragonRuby Game Toolkit from either Itch.io (standard) or the DragonRuby website (pro).
2. Install your downloaded copy of DragonRuby: smaug dragonruby install ~/Downloads/dragonruby-linux-amd64.zip.
3. Create a new project: smaug new my-game then cd my-game.
4. Edit your project's configuration at Smaug.toml.
5. Run your game: smaug run.
6. Build your game: smaug build.
   • Builds will be stored in my-game/builds.
7. Publish your game: smaug publish.

Migrate an existing DragonRuby project

The following instructions assume your project lives at ~/projects/dragonruby-linux-amd64/mygame.

1. Move your game's directory outside of the DragonRuby directory: mv ~/projects/dragonruby-linux-amd64/mygame ~/projects/mygame.
2. Install your version of DragonRuby: smaug dragonruby install ~/projects/dragonruby-linux-amd64.
3. Add smaug to your project: smaug init ~/projects/mygame.
4. cd ~/projects/mygame
5. Edit your project's configuration at Smaug.toml.
6. Run your game: smaug run.
7. Build your game: smaug build.
   • Builds will be stored in my-game/builds.
8. Publish your game: smaug publish.

Install a package

1. Edit Smaug.toml:

   [dependencies]
   draco = "0.6.1"
   

2. Run smaug install
3. Add require "app/smaug.rb" to the top of your main.rb.

Package Sources

# Smaug Registry
name = "version"

# Directory
name = "path/to/package"

# Zip File
name = "path/to/package.zip"

# Online Zip File
name = "https://example.com/package.zip"

# Git Repository
name = "https://github.com/example/package"

# Git Repository Tag
name = { repo = "https://github.com/example/package", tag = "v1.0" }

Creating a package

1. Run dragonruby package init from your package's directory.
2. Edit your package's new Smaug.toml file to configure the package.
3. Add each of the files that are needed for the DragonRuby project.

   requires = [
       "lib/library.rb",
       "lib/library/other.rb"
   ]
   

4. Publish your changes.

Install Files

You can install files into the game project from your package.

[package.installs]
# "location in package" = "location in game project"
"tiles/grass.png" = "app/sprites/grass.png"