Smaug

Smaug是管理您的DragonRuby游戏工具包项目的一个工具。

安装

手动安装

您可以从发布页面下载最新版本。

Linux

Arch Linux

Smaug在AUR上。

Mac

使用homebrew安装。

brew tap ereborstudios/tap
brew install smaug

Windows

使用scoop安装。

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

其他操作系统

我们不维护其他操作系统的软件包。您可以使用Cargo作为包管理器。

1. 通过您的包管理器或使用rustup安装rust
2. 运行cargo install smaug-bin

用法

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.

开始一个新的DragonRuby项目

1. 从Itch.io（标准）或DragonRuby网站（专业版）下载DragonRuby游戏工具包的副本。
2. 安装您下载的DragonRuby： smaug dragonruby install ~/Downloads/dragonruby-linux-amd64.zip。
3. 创建新项目： smaug new my-game 然后运行 cd my-game。
4. 在 Smaug.toml 中编辑您的项目配置。
5. 运行您的游戏： smaug run。
6. 构建您的游戏： smaug build。
   • 构建将保存在 my-game/builds 中。
7. 发布您的游戏： smaug publish。

迁移现有的DragonRuby项目

以下说明假设您的项目位于 ~/projects/dragonruby-linux-amd64/mygame。

1. 将您的游戏目录移动到DragonRuby目录之外： mv ~/projects/dragonruby-linux-amd64/mygame ~/projects/mygame。
2. 安装您的DragonRuby版本： smaug dragonruby install ~/projects/dragonruby-linux-amd64。
3. 将smaug添加到您的项目中： smaug init ~/projects/mygame。
4. cd~/projects/mygame
5. 在 Smaug.toml 中编辑您的项目配置。
6. 运行您的游戏： smaug run。
7. 构建您的游戏： smaug build。
   • 构建将保存在 my-game/builds 中。
8. 发布您的游戏： smaug publish。

安装包

1. 编辑 Smaug.toml

   [dependencies]
   draco = "0.6.1"
   

2. 运行 smaug install
3. 将 require "app/smaug.rb" 添加到您的 main.rb 文件的顶部。

包源

# 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" }

创建一个包

1. 从您的包目录中运行 dragonruby package init。
2. 编辑您的包的新 Smaug.toml 文件以配置包。
3. 添加所有需要的文件到DragonRuby项目。

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

4. 发布您的更改。

安装文件

您可以从您的包中安装文件到游戏项目中。

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