Repository files navigation

A Rust framework for building Minecraft: Java Edition servers.

Built on top ofBevy ECS, Valence is an effort to create aMinecraft compatible server completely from scratch in Rust. You can think of Valence as agame engine forMinecraft servers. It doesn't do much by default, but by writing game logic yourself and leveraging Bevy'spowerfulplugin system, you can make almost anything.

Opinionated features like dynamic scripting, dedicated executables, and vanilla game mechanics are all expected to bebuilt as optional plugins. This level of modularity is desirable for those looking to build highly custom experiencesin 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.

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 andcansupportthousandsof 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 notplanned. However, you can use a proxy withViaBackwards toachieve backwards compatibility with older clients.

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 togenerate 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,BungeecordandWaterfall)

Here is ashort video showing the examples and some ofValence's capabilities.

After cloning the repository, run this command to try an example.

cargo r -r --example parkour

I also recommend givinggame_of_life,terrain, andcow_sphere a try.

Next, open your Minecraft client and connect to the addresslocalhost.If all goes well you should be playing on the server.

Valence is published tocrates.io. Runcargo add valence to add it to yourproject.

However, the crates.io version is likely outdated. To use the most recent development version, add Valence as agit dependency.

[dependencies]valence = {git ="https://github.com/valence-rs/valence" }

Documentation from the main branch is availablehere.

Contributions are welcome! PleaseseeCONTRIBUTING.md. You canjoinDiscord orGitHub Discussionsto discuss the project and ask questions.

Code is licensed underMIT while the Valence logo isunderCC BY-NC-ND 4.0

If you would like to contribute financially, consider sponsoring me (rj00a)onGitHuborPatreon.

I would love to continue working on Valence and your support would help me do that. Thanks!