7 个版本

0.4.0-alpha.3 2024 年 8 月 17 日
0.4.0-alpha.02024 年 8 月 16 日
0.3.0 2024 年 7 月 4 日
0.3.0-pre.22024 年 7 月 2 日
0.3.0-pre.12024 年 7 月 1 日

#102构建工具

Download history 453/week @ 2024-07-01 19/week @ 2024-07-08 17/week @ 2024-07-15 10/week @ 2024-07-29 460/week @ 2024-08-12

470 每月下载量
用于 8 个包 (5 直接)

MIT/Apache

56KB
1K SLoC

Dexterous Developer

GitHub Workflow Status (with event) GitHub Workflow Status (with event) crates.io cli

Rust 的模块化热重载系统。

最新版本的文档可在以下地址找到: https://lee-orr.github.io/dexterous_developer/

您还可以找到 最新预发布版本的文档主分支的文档

特性

  • 一个 CLI,用于构建和运行可重载的 Rust 项目,包括跨网络(跨设备)
  • 直接与二进制包协同工作!
  • 序列化和反序列化元素的能力,允许在时间上演变模式
  • 只有当你明确启用时才包含构建中的热重载功能 - 例如使用 CLI 启动器
  • 创建适配器的能力,允许您使用 Dexterous Developer 工具与其它工具配合使用。
  • 包括第一方的 Bevy 适配器
  • 在 Windows、Linux 和 MacOS 上运行
  • 在 Linux 上,可以在运行主操作系统的同时在开发容器内进行开发,使开发容器可用于游戏和其他 GUI 应用。

Bevy 特定功能

  • 明确定义游戏的可重载区域 - 可以包括系统、组件、事件和资源(有一些限制)
  • 在重载时将资源重置为默认值或预先确定的值
  • 序列化和反序列化可重载资源与组件,允许您演变它们的模式,只要它们与反序列化器兼容(使用 rmp_serde)
  • 标记实体以便在热重载时删除
  • 在热重载后运行系统
  • 创建函数来在进入/退出状态或热重载时设置和销毁

未来工作

  • 跨平台热重载 - 在开发环境中运行 "热重载服务器",并在不同的操作系统上执行应用程序
  • 移动设备支持
  • 基于浏览器的WASM支持
  • WASI支持
  • 使用中间编译结果修补运行中的库
  • 除了当前的动态库方法外,支持进程间通信的使用
  • 应添加基于GUI的启动器,尤其是对于移动设备
  • 在bevy中支持ECS钩子和观察者

安装

通过运行以下命令安装CLI:cargo install [email protected]。这将安装2个命令行工具

  • dexterous_developer_cli - 用于构建项目,可能同时运行它
  • dexterous_developer_runner - 用于在另一台设备上运行项目

设置

您还需要将适当的dexterous开发者适配器添加到库的依赖中,并设置 "热" 功能。例如,如果您正在使用bevy

[features]
hot = ["bevy_dexterous_developer/hot"]

[dependencies]
bevy = "0.14"
bevy_dexterous_developer = { version = "0.4.0-alpha.3"}
serde = "1" # If you want the serialization capacities

最后,您需要设置一个Dexterous.toml文件,它有助于定义一些必要的元素 - 例如,哪些文件夹应监视更改,以及应启用哪些功能。请参阅此存储库中的示例文件书籍以获取更多信息。

Bevy设置

在您的main.rs中,您的主函数应变为

reloadable_main!((initial_plugins) {
    App::new()
        .add_plugins(initial_plugins.initialize::<DefaultPlugins>()) // You can use either DefaultPlugins or MinimnalPlugins here, and use "set" on this as you would with them
    // Here you can do what you'd normally do with app
    // ... and so on
});

如果您有一个插件,其中您想添加可重载的元素,请在定义插件的文件中添加以下内容


impl Plugin for MyPlugin {
    fn build(&self, app: &mut App) {
        app
            .setup_reloadable_elements::<reloadable>();
    }
}

reloadable_scope!(reloadable(app) {
    app
        .add_systems(Update, this_system_will_reload);
})

Simple Visual示例显示了库的基本用法,并且书籍也有更多信息。

使用热重载运行

要本地运行热重载应用程序,请运行dexterous_developer_cli(可选地传递特定包或示例)。

要在不同的机器(具有相同平台)上运行应用程序,请在这两台机器上分别运行dexterous_developer_cli,然后

  • 在开发机器上运行dexterous_developer_cli --serve-only
  • 在目标机器上运行dexterous_developer_runner --server http://*.*.*.*:4321命令,理想情况下在专用目录中

不使用热重载运行或构建

要构建或运行不使用热重载的应用程序版本,请记住要避免包含hot功能,因为它旨在仅在可重载的库内工作!。

灵感

最初的灵感来自DGriffin91的Ridiculous bevy热重载

Bevy版本支持

Bevy Dexterous Developer
0.14 >= 0.3
0.13 = 0.2
0.12 0.0.12, 0.1
0.11 <= 0.0.11

依赖关系

~4–11MB
~116K SLoC