Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valence-rs/valence
A Rust framework for building Minecraft servers.
https://github.com/valence-rs/valence
bevy ecs game gamedev hacktoberfest minecraft rust server
Last synced: 5 days ago
JSON representation
A Rust framework for building Minecraft servers.
- Host: GitHub
- URL: https://github.com/valence-rs/valence
- Owner: valence-rs
- License: mit
- Created: 2022-01-20T13:47:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T11:40:08.000Z (3 months ago)
- Last Synced: 2024-10-29T14:55:34.288Z (3 months ago)
- Topics: bevy, ecs, game, gamedev, hacktoberfest, minecraft, rust, server
- Language: Rust
- Homepage: http://valence.rs/
- Size: 5.72 MB
- Stars: 2,787
- Watchers: 37
- Forks: 143
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-minecraft - Valence
- awesome - valence-rs/valence - A Rust framework for building Minecraft servers. (Rust)
- awesome - valence-rs/valence - A Rust framework for building Minecraft servers. (Rust)
README
A Rust framework for building Minecraft: Java Edition servers.
Built on top of [Bevy ECS](https://bevyengine.org/learn/book/getting-started/ecs/), Valence is an effort to create a
Minecraft compatible server completely from scratch in Rust. You can think of Valence as a _game engine for
Minecraft servers_. It doesn't do much by default, but by writing game logic yourself and leveraging Bevy's
powerful [plugin system](https://bevyengine.org/learn/book/getting-started/plugins/), you can make almost anything.
Opinionated features like dynamic scripting, dedicated executables, and vanilla game mechanics are all expected to be
built as optional plugins. This level of modularity is desirable for those looking to build highly custom experiences
in Minecraft such as minigame servers.
⚠️ **Valence is still early in development with many features unimplemented or incomplete. Expect to encounter bugs, limitations, and breaking changes.**
# Goals
Valence aims to be the following:
* **Complete**. Abstractions for the full breadth of the Minecraft protocol.
* **Flexible**. Can easily extend Valence from within user code. Direct access to the Minecraft protocol is provided.
* **Modular**. Pick and choose the components you need.
* **Intuitive**. An API that is easy to use and difficult to misuse. Extensive documentation and examples are important.
* **Efficient**. Optimal use of system resources with multiple CPU cores in mind. Valence uses very little memory and
can
support [thousands](https://raw.githubusercontent.com/valence-rs/valence/main/assets/many-players.png)
of players at the same time without lag (assuming you have the bandwidth).
* **Up to date**. Targets the most recent stable version of Minecraft. Support for multiple versions at once is not
planned. However, you can use a proxy with [ViaBackwards](https://www.spigotmc.org/resources/viabackwards.27448/) to
achieve backwards compatibility with older clients.
## Current Status
Here are some noteworthy achievements:
- `valence_nbt`: A speedy new library for Minecraft's Named Binary Tag (NBT) format.
- Authentication, encryption, and compression
- Block states
- Chunks
- Entities and metadata
- Bounding volume hierarchy for fast spatial entity queries
- Player list and player skins
- Dimensions, biomes, and worlds
- JSON Text API
- A Fabric mod for extracting data from the game into JSON files. These files are processed by a build script to
generate Rust code for the project. The JSON files can be used in other projects as well.
- Inventories
- Items
- Particles
- Anvil file format (read only)
- Proxy support ([Velocity](https://velocitypowered.com/), [Bungeecord](https://www.spigotmc.org/wiki/bungeecord/)
and [Waterfall](https://docs.papermc.io/waterfall))
Here is a [short video](https://www.youtube.com/watch?v=jkw9fZx9Etg) showing the examples and some of
Valence's capabilities.
# Getting Started
## Running the Examples
After cloning the repository, run this command to try an example.
```shell
cargo r -r --example parkour
```
I also recommend giving `game_of_life`, `terrain`, and `cow_sphere` a try.
Next, open your Minecraft client and connect to the address `localhost`.
If all goes well you should be playing on the server.
## Adding Valence as a Dependency
Valence is published to [crates.io](https://crates.io/crates/valence). Run `cargo add valence` to add it to your
project.
However, the crates.io version is likely outdated. To use the most recent development version, add Valence as a
[git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).
```toml
[dependencies]
valence = { git = "https://github.com/valence-rs/valence" }
```
Documentation from the main branch is available [here](https://valence.rs/rustdoc/valence/).
# Contributing
Contributions are welcome! Please
see [CONTRIBUTING.md](https://github.com/valence-rs/valence/blob/main/CONTRIBUTING.md). You can
join [Discord](https://discord.gg/8Fqqy9XrYb) or [GitHub Discussions](https://github.com/valence-rs/valence/discussions)
to discuss the project and ask questions.
# License
Code is licensed under [MIT](https://opensource.org/licenses/MIT) while the Valence logo is
under [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)
# Funding
If you would like to contribute financially, consider sponsoring me (rj00a)
on [GitHub](https://github.com/sponsors/rj00a)
or [Patreon](https://www.patreon.com/rj00a).
I would love to continue working on Valence and your support would help me do that. Thanks!