alex/valence
1
0
Fork 0
mirror of https://github.com/italicsjenga/valence.git synced 2024-12-23 22:41:30 +11:00
Code Issues Packages Projects Releases Wiki Activity

Add link to CONTRIBUTING.md in README.md

Browse source
This commit is contained in:
Ryan Johnson 2022-10-08 18:08:48 -07:00 committed by GitHub
parent b0646a5398
commit f26f4be1fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -2,9 +2,13 @@
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. 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. 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
@ -77,8 +81,9 @@ View the documentation by running `cargo d --open` in your project.
# Contributing # Contributing
Contributions are welcome! Take a look at the [issue tracker](https://github.com/rj00a/valence/issues) to see what needs Contributions are welcome! Please
to be done. You can also join [the Discord](https://discord.gg/8Fqqy9XrYb) to discuss the project and ask questions. see [CONTRIBUTING.md](https://github.com/valence-rs/valence/blob/main/CONTRIBUTING.md). You can also
join [the Discord](https://discord.gg/8Fqqy9XrYb) to discuss the project and ask questions.
# License # License
@ -87,7 +92,8 @@ under [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)
# Funding # Funding
If you would like to contribute financially consider sponsoring me (rj00a) on [GitHub](https://github.com/sponsors/rj00a) 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) (GitHub is preferred). or [Patreon](https://www.patreon.com/rj00a) (GitHub is preferred).
I would love to continue working on Valence and your support would help me do that. Thanks! I would love to continue working on Valence and your support would help me do that. Thanks!