bones README

项目的 README,来自 github.com/fishfolk/bones。合并为一个 markdown 文件:README.md。

Bones

A 'meta-engine' framework made to facilitate the development of moddable, multiplayer 2D games.

Documentation Crates.io docs.rs Main Branch Docs License Discord


Initially borne out of Jumpy, Bones will eventually be the engine of choice for all Fish Folk games. It is suitable for any other games with similar requirements.

By default Bones is rendered with Bevy, but it is fundamentally engine-agnostic and comes with its own lightweight ECS, asset server and user experience. Bones is officially focused on 2D games and models itself after the likes of Corgi. It can however be used for 3D games as well, if you are willing to create custom rendering integrations.

Overview

Bones ECS

Bones is designed around a simple, custom Entity Component System (ECS), designed to make it easier to get a few features that are important to us:

Determinism and Snapshot/Restore are also key features for getting excellent network play with the rollback networking model, while requiring no changes to the core game loop implementation.

Bones Lib

The bones_lib contains the bones_ecs and the bones_asset system. It defines the concept of a Game which contains all of your game logic and data in a collection of Sessions that each have their own ECS World.

Bones lib has no rendering components or even math types, it is only concerned with organizing your game logic and assets.

Bones Framework

On top of bones_lib there is the bones_framework, which defines the rendering components and math types. Right now bones_framework is focused only on 2D rendering. 3D is not a priority for us now, but there is no technical limitation preventing community developed 3D rendering components either on top of bones_lib directly or as an extension to the bones_framework.

Bones Bevy Renderer

A game created with only the bones_framework is renderer agnostic, allowing us to create rendering integrations with other engines. Our official integration is with the [Bevy] engine.

Rendering in the bones_framework is intentionally simple, and some games may need more advanced features that aren't supported out of the box. Bones, and it's Bevy integration, are designed so that you can create custom rendering specific to your needs. That means you can still take advantage of any fancy new Bevy plugins, or maybe use something other than Bevy entirely!

Bones Scripting

bones_ecs is built to be scripted. Effort has also been made to avoid putting unnecessary performance limitations into the scripting system. Bones comes with an integration with the piccolo VM to enable Lua scripting out-of-the-box.

This integration allows Lua scripts to access the ECS world in a way very similar to the Rust API. Rust components and resources can be annotated with #[repr(C)] to enable direct access by Lua scripts, and if a type cannot be #[repr(C)], you can still manually create your own Lua bindings for that type.

Allowing both Rust and the scripting language to talk to the same ECS world allows you to easily blend both languages in your game, and have them interact quite easily in many circumstances. If a portion of your game needs extra high performance or low-level access, you can use Rust, but if you want hot reloaded and moddable elements of your game, you can use Lua.

The scripting system is not limited to Lua. Using the simple dynamic API to bones_ecs, you can create your own integrations to any language or system you desire.

The scripting system is new and work-in-progress, but all of the major things have been successfully implemented, and it is going to be actively used in Jumpy.

Contributing

If you would like to contribute, feel free to reach out on our Discord server to ask questions!

We also use TODO Issue to automatically create issues from all of our TODO comments in code. You can check out the todo issue list to see if there's any thing you'd like to take a hack at.

Similar Projects

Our architecure has many things in common with these other awesome projects:

bones (fishfolk/bones)

正在搜索数据库…

323 ·GitHub
这是什么?Bones 是一个用于开发可模组化、多人联机 2D 游戏的 Rust「元引擎」框架。它源自 Fish Folk 游戏 Jumpy,最终目标是为所有 Fish Folk 游戏提供底层支持。
这是一个完整的游戏引擎,还是只是 Bevy 的渲染插件?它与具体引擎无关:Bones 自带轻量级的 ECS、资源服务器和脚本系统,只是默认使用 Bevy 来做渲染,因此也可以换成其他渲染器。
用它做游戏必须要用 Bevy 吗?严格来说不必。Bones 的核心库完全不包含渲染或数学相关的类型,它只负责组织游戏逻辑和资源;Bevy 只是官方提供的、叠加在其上的渲染集成方案。
它支持 3D 游戏吗?不太支持。Bones Framework 官方只专注于 2D 渲染;理论上可以做 3D,但需要自己编写定制的渲染集成。
能用 Lua 而不是纯 Rust 来编写游戏脚本吗?可以。Bones 内置了与 'piccolo' 虚拟机的开箱即用集成,用于 Lua 脚本,让 Lua 脚本能够访问与 Rust API 相同的 ECS 世界,从而实现可热重载的模组开发。
为什么说 ECS 是确定性的?Bones ECS 默认就是确定性的,其 World 可以轻松地快照和恢复,这使得无需改动核心游戏循环,就能实现回滚式的多人联机网络。
Jumpy 和这个引擎是什么关系?Jumpy 是 Bones 所从中提取出来的 Fish Folk 游戏,Bones 正在被泛化,以便最终能够驱动所有 Fish Folk 游戏以及其他类似项目。
Bones 的架构受到了哪些项目的启发?README 列出了它与之有共同理念的类似项目,包括 Gamercade/wasm4、Ambient、flecs-polyglot 和 Tangle。
作者
fishfolk
大小
377.3 MB
星标
323
时长
3年
提交 · 90 天