Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 9.82 KB

README.md

File metadata and controls

94 lines (65 loc) · 9.82 KB

Ambient

Crates.io docs.rs MIT/Apache 2.0 Discord

Ambient is a runtime for building high-performance multiplayer games and 3D applications, powered by WebAssembly, Rust and WebGPU.

See our announcement blog post for more details.

Design principles

  • Seamless networking: Ambient is both your server and client. All you need to do is to build your server and/or client-side logic: the runtime handles synchronization of data for you.
  • Isolation: Projects you build for Ambient are executed in isolation through the power of WebAssembly - so that if something crashes, it won’t take down your entire program. It also means that you can run untrusted code safely.
  • Data-oriented design: The core data model of Ambient is an entity component system which each WASM module can manipulate.
  • Language-agnostic: You will be able to build Ambient modules in any language that can compile to WebAssembly. At present, Rust is the only supported language, but we are working on expanding to other languages.
  • Single executable: Ambient is a single executable which can run on Windows, Mac and Linux. It can act as a server or as a client.
  • Interoperability: Ambient allows you to define custom components and "concepts" (collections of components). As long as your Ambient projects use the same components and concepts, they will be able to share data and interoperate, even if they have no awareness of each other.
  • Asset pipeline and streaming: Ambient has an asset pipeline that is capable of compiling multiple asset formats, including .glb and .fbx. The assets are always streamed over the network, so your clients will receive everything they need when they join.
  • Powerful renderer: The Ambient renderer is GPU-driven, with both culling and level-of-detail switching being handled entirely by the GPU. By default, it uses PBR. It also supports cascading shadow maps and instances everything that can be instanced.

See the documentation for a guide on how to get started, or browse the examples.

Installing

The easiest way to get Ambient is by downloading the latest release here.

For alternative installation options, go to the documentation on installing.

Roadmap

Note: Ambient is in an alpha stage and the API will be iterated on heavily. We are working towards a stable release.

Feature Status Notes
ECS Single-threaded.
WASM API Rust is the only supported guest language right now, and WASM can only be used on the server. We are working on clientside WASM; see this issue.
Multiplayer/networking Multiplayer is server-authoritative without any prediction or compensation. See this issue.
GPU-driven renderer
FBX & glTF loading
Physics (through PhysX) Using PhysX 4.1. PhysX 5 support is tracked in this issue.
Animations
Skinmeshing
Shadow maps
Decals
GPU culling and LoD
Multi-platform Windows, Mac, and Linux so far. x86-64 and ARM64 are actively supported; other platforms may also work, but require testing.
Run on Web 🚧 See this issue.
Multithreading API 🚧 Multithreading is already used internally, but we want to expose multithreading functionality within the WASM API. This may be explicit (i.e. task- or thread-spawning) or implicit (WASM modules being scheduled across threads).
UI API 🚧 A React-like UI library already exists in the repo, and we're working on exposing it through the WASM API. See this issue.
Custom shaders 🚧 Custom shaders are supported by the renderer, but are not yet exposed in the API. See this issue.
Hot-reloading assets 🚧 See this issue.
Audio 🚧 Audio is supported, but not currently exposed. See this issue.
ECS save/load 🚧 For loading, see this issue.

Examples

Each example in the examples directory can be run with Ambient as both client and server:

  • cd guest/rust/examples/tictactoe
  • ambient run

Every example can also be run server-only. To do so:

  • cd guest/rust/examples/tictactoe
  • ambient serve

This will start a server that other people, including yourself, can join (assuming that ports 8999 and 9000 are forwarded):

  • ambient join [IP_OF_SERVER]

Note that content is always streamed, so the only thing the joining user requires is Ambient itself to join the session.

Contributing

We welcome community contributions to this project.

Please talk with us on Discord beforehand if you'd like to contribute a larger piece of work.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.