Explain the project better in the README

This commit is contained in:
Ryan Johnson 2022-09-03 20:27:49 -07:00 committed by GitHub
parent ebbea74017
commit 2ee96056a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -2,6 +2,10 @@
A Rust framework for building Minecraft: Java Edition servers. A Rust framework for building Minecraft: Java Edition servers.
Like [feather](https://github.com/feather-rs/feather), Valence is an effort to build a Minecraft compatible server completely from scratch in Rust. The difference is that Valence has decided to organize the effort a little differently. All game logic is behind a trait. This approach has many advantages. Features such as a plugin system, dedicated executable, and vanilla game mechanics can be implemented _on top of_ Valence. Valence is a Rust library like any other.
In the future we may decide to reimplement vanilla game mechanics as a separate project. If you're developing something like a minigame server without need for vanilla game mechanics, you can depend on Valence directly.
# Goals # Goals
Valence aims to be the following: Valence aims to be the following: