2个不稳定版本

0.2.0 2022年2月11日
0.1.0 2022年2月7日

#1755 in 游戏开发

MIT/Apache

20KB
379

财政

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

    外部目录是存储远程资产所有元数据文件的地方。此目录 应该 在存储库中,并且不应被版本控制系统忽略。

  • 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 包的主版本进行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: URL。这对于处理本地资产来说已经足够了。
  • 🔥 热重载 🔥 目前尚不可行,因为服务器没有监听源文件的变化。

许可

许可证为以下之一

任选其一。

贡献

除非您明确表示,否则根据 Apache-2.0 许可证定义的,您提交给工作的任何有意贡献都应按上述方式双重许可,不附加任何其他条款或条件。

依赖项

~14–27MB
~360K SLoC