4个版本

0.2.2 2022年2月12日
0.2.1 2022年2月11日
0.2.0 2022年2月11日
0.1.0 2022年2月7日

#2022 in 游戏开发

42 每月下载次数
treasury-server 中使用

MIT/Apache

105KB
2.5K SLoC

国库

crates docs actions MIT/Apache loc

国库是一个易于使用的库和工具集合,用于为游戏引擎或其他应用程序创建资产管道。

目录

💻 安装

treasury提供的应用程序可以使用cargo安装。

要安装treasury-server,请运行

cargo install treasury-server

要安装treasury命令行工具

cargo install treasury-cli

✋ 使用

⚡ 初始化

要开始使用国库,必须创建一个实例。国库实例由Treasury.toml文件定义。文件的父目录称为“基本目录”。

此文件可以手动创建👷或使用以下方法

  • CLI工具

    treasury init
    

    将使用当前目录作为基本目录初始化国库实例。

    treasury --base <path> init
    

    将使用基本目录<path>初始化国库实例。

  • 客户端库API提供了方法Client::local。将init参数设置为true时,它将初始化国库。这在上面的CLI调用中内部使用。

⚡ 配置

默认的Treasury.toml文件如下所示

是的,一个空文件。

有四个字段可以被覆盖。

  • artifacts = "<path>"
    

    将覆盖工件目录为相对于<base>指定的路径。默认为<base>/treasury/artifacts

    工件目录用于存储所有工件。这不应该由版本控制系统(VCS)管理。如果路径位于仓库内部,则应该忽略。如果国库创建了工件目录(当存储工件且目录不存在时),它将创建包含 "*" 的 .gitignore 文件。

  • external = "<path>"
    

    将覆盖外部目录到指定路径,相对于 <base>。默认为 <base>/treasury/external

    外部目录用于存储远程资产的全部元数据文件。此目录 位于仓库中,不应被 VCS 忽略。

  • temp = "<path>"
    

    将覆盖临时文件默认目录。默认为 std::env::temp_dir() 的结果。临时文件用作下载供导入器消耗和导入器输出的中间存储。

  • importers = ["<list>", "<of>", "<paths>"]
    

    将告知应使用哪些导入器库为此实例。
    对于 Rust 项目,它们通常位于 cargo 工作区的目标目录中。

一旦初始化了 Treasury 实例,就可以用它来存储和检索资产。

⚡ 存储

在 Treasury 中存储资产很简单。使用 CLI 的话,看起来是这样的

treasury store <source-path> <target-format>

输出中的最后一行将包含 AssetId,如果存储操作成功。否则将打印错误。

如果源格式不明确,可以在目标格式之后指定。

treasury store <source-path> <target-format> <source-format>

要使用 URL 存储资产,请使用 --url(简称 -u)标志。

treasury store --url <source-url> <target-format> <source-format>

没有此标志,源参数始终被解释为文件路径。使用此标志,源参数始终被解释为 URL。这也可以是 file: URL。

使用库 API 存储时,使用 treasury_client::Client::store_asset 方法。

存储过程

整个过程可以描述为四个步骤

  1. 用户提供资产源、最终应用将使用的目标格式,以及可选的源格式。只有在不明确时才需要源格式。
  2. 注册的导入器匹配源和目标格式并运行,将资产处理成工件。
  3. Treasury 存储生成的工件。它避免了存储重复项,但不同的资产可以指向同一工件。
  4. 返回 AssetId。

⚡ 检索

用户可以使用资产源和目标格式或 AssetId 检索已存储资产的工件。工件应始终使用 AssetId。当资产源迁移时,.treasury 文件也应随之迁移。在这种情况下,不需要重新导入,并且它们的 AssetId 将被保留。

⚡ 导入器

为了存储资产,需要一个导入器将资产源 🥚 转换为工件 🐤。

导入器是实现了 treasury_import::Importer 特性的类型。
Treasury 可以配置为从动态库加载导入器。

为了简化编写导入器库并最大限度地减少由无效实现引起的问题,应使用 treasury_import::make_treasury_importers_library 宏。
此宏将导出服务器期望的所有必要符号。它将确保使用 treasury_import crate 的主要版本进行 ABI 兼容性。此宏及其生成的代码将执行所有不安全操作,使导入器库的作者拥有简单且 100% 安全的 Rust。

示例导入器

基本导入库可能看起来像这样

# Cargo.toml
[package]
name = "my-importer"
version = "0.1.0"
edition = "2021"

[lib]
crate-type = ["cdylib"]

[dependencies]
treasury-import = { path = "../../import" }
//! src/lib.rs
struct MyImporter;

impl treasury_import::Importer for MyImporter {
    fn import(
        &self,
        source: &std::path::Path,
        output: &std::path::Path,
        _sources: &impl treasury_import::Sources,
        _dependencies: &impl treasury_import::Dependencies,
    ) -> Result<(), treasury_import::ImportError> {
        match std::fs::copy(source, output) {
          Ok(_) => Ok(()),
          Err(err) => Err(treasury_import::ImporterError::Other { reason: "SOMETHING WENT WRONG".to_owned() }),
        }
    }
}


// Define all required exports.
treasury_import::make_treasury_importers_library! {
    // [extensions list]  <name> : <source-format> -> <target-format> = <expr>;
    // <expr> must have type &'static I where I: Importer
    // Use `Box::leak(importer)` if importer instance cannot be constructed in constant expression.
    [foo] foo : foo -> foo = &FooImporter;
}

导入过程产生的工件应始终使用 AssetId 来引用依赖。资产源文件可以包含路径(相对于源文件或绝对路径)或URL,可以通过 Dependencies 容易地转换为 AssetId。如果未找到依赖项,则应返回 ImportResult::RequireDependencies { ... }。存储过程将尝试存储依赖项并重试导入。

缺少什么?

目前,此项目是资产管道的简单实现。

  • 打包尚未实现。必须有一种方法可以将工件子集打包成针对磁盘存储和无需间接引用的加载进行优化的包。
  • 服务器尚未准备好在远程模式下使用。为此,服务器应能够从请求存储操作的客户那里获取本地源数据。
  • 目前仅支持 file:data: URLs。这对于处理本地资产已经足够。
  • 🔥 热重载 🔥 不可用,因为服务器不监视 👀 源中的更改。

许可证

许可证根据您的选择

贡献

除非您明确说明,否则根据 Apache-2.0 许可证定义,您有意提交以包含在作品中的任何贡献,均应按上述方式双重许可,而无需任何附加条款或条件。

依赖项

~11–26MB
~339K SLoC