This PR redesigns Valence's architecture around the Bevy Entity Component System framework (`bevy_ecs` and `bevy_app`). Along the way, a large number of changes and improvements have been made. - Valence is now a Bevy plugin. This allows Valence to integrate with the wider Bevy ecosystem. - The `Config` trait has been replaced with the plugin struct which is much easier to configure. Async callbacks are grouped into their own trait. - `World` has been renamed to `Instance` to avoid confusion with `bevy_ecs::world::World`. - Entities, clients, player list, and inventories are all just ECS components/resources. There is no need for us to have our own generational arena/slotmap/etc for each one. - Client events use Bevy's event system. Users can read events with the `EventReader` system parameter. This also means that events are dispatched at an earlier stage of the program where access to the full server is available. There is a special "event loop" stage which is used primarily to avoid the loss of ordering information between events. - Chunks have been completely overhauled to be simpler and faster. The distinction between loaded and unloaded chunks has been mostly eliminated. The per-section bitset that tracked changes has been removed, which should further reduce memory usage. More operations on chunks are available such as removal and cloning. - The full client's game profile is accessible rather than just the textures. - Replaced `vek` with `glam` for parity with Bevy. - Basic inventory support has been added. - Various small changes to `valence_protocol`. - New Examples - The terrain and anvil examples are now fully asynchronous and will not block the main tick loop while chunks are loading. # TODOs - [x] Implement and dispatch client events. - ~~[ ] Finish implementing the new entity/chunk update algorithm.~~ New approach ended up being slower. And also broken. - [x] [Update rust-mc-bot to 1.19.3](https://github.com/Eoghanmc22/rust-mc-bot/pull/3). - [x] Use rust-mc-bot to test for and fix any performance regressions. Revert to old entity/chunk update algorithm if the new one turns out to be slower for some reason. - [x] Make inventories an ECS component. - [x] Make player lists an ECS ~~component~~ resource. - [x] Expose all properties of the client's game profile. - [x] Update the examples. - [x] Update `valence_anvil`. - ~~[ ] Update `valence_spatial_index` to use `glam` instead of `vek`.~~ Maybe later - [x] Make entity events use a bitset. - [x] Update docs. Closes #69 Closes #179 Closes #53 --------- Co-authored-by: Carson McManus <dyc3@users.noreply.github.com> Co-authored-by: AviiNL <me@avii.nl> Co-authored-by: Danik Vitek <x3665107@gmail.com> Co-authored-by: Snowiiii <71594357+Snowiiii@users.noreply.github.com>
4.8 KiB
Valence has a public Discord server here. Check it out if you have additional questions or comments.
What version of Rust should I use?
To use Valence, only the most recent stable version of Rust is required. However, contributors should know that
unstable rustfmt
settings are enabled in the project. To run rustfmt
with the nightly toolchain, use
the cargo +nightly fmt
command.
What issues can I work on?
Issues labelled good first issue are a good place to start. This label is reserved for issues that shouldn't require too much specialized domain knowledge to complete. New contributors are not required to start with these issues.
If you plan to work on something that's not an open issue, consider making one first so that it can be discussed. This way, your contribution will not be rejected when it is submitted for review.
Playgrounds and Examples
Examples (found in the examples/
directory) are a great way to document how pieces of Valence's API fit together. It's important that they remain as simple as possible. If you're working on a feature that requires a more complex scenario, consider making a playground instead.
Examples can be run with cargo run -p valence --example <example_name>
.
Playgrounds are meant to provide a quick and minimal environment to test out new code or reproduce bugs. Playgrounds are also a great way test out quick ideas. This is the preferred method for providing code samples in issues and pull requests.
To get started with a new playground, copy the template to playground.rs
.
cp crates/playground/src/playground.template.rs crates/playground/src/playground.rs
Make your changes to crates/playground/src/playground.rs
. To run it:
cargo run -p playground # simply run the playground, or
cargo watch -c -x "run -p playground" # run the playground and watch for changes
Automatic Checks
When you submit a pull request, your code will automatically run through clippy, rustfmt, etc. to check for any errors. If an error does occur, it must be fixed before the pull request can be merged.
Code Conventions
Here are some rules you should follow for your code. Generally the goal here is to be consistent with existing code, the standard library, and the Rust ecosystem as a whole. Nonconforming code is not necessarily a blocker for accepting your contribution. It's just nice to have.
These guidelines are intended to complement the Rust API Guidelines.
Top-down Modules
Readers of the module should be able to understand your code by reading it from top to bottom.
Whenever items in your module form a parent-child relationship, the
parent should be written above the children. Typically this means that important pub
items are placed before private
implementation details.
For instance, here are three functions. Notice how the definition of foo
is placed above its dependencies. The parent
is foo
while its children are bar
and baz
.
pub fn foo() {
bar();
baz();
}
fn bar() {}
fn baz() {}
This guideline applies to types as well.
pub struct Foo {
bars: Vec<Bar>,
}
struct Bar {
// ...
}
Getters and Setters
Getters and setters should be named like this:
impl Foo {
fn bar(&self) -> &Bar { ... }
fn set_bar(&mut self, bar: Bar) { ... }
}
And not like this:
impl Foo {
fn get_bar(&self) -> &Bar { ... }
fn set_bar(&mut self, bar: Bar) { ... }
}
See SocketAddr
for an example of a standard library
type that uses this convention.
Under appropriate circumstances a different naming scheme can be
used. Command
is a standard type that demonstrates
this.
If a bar
field exists and no invariants need to be maintained by the getters and setters, it is usually better to make
the bar
field public.
Naming Quantities
Quantities of something should be named foo_count
where foo
is the thing you're quantifying. It would be incorrect
to name this variable num_foos
.
Documentation
All public items should be documented. Documentation must be written with complete sentences and correct grammar. Consider using intra-doc links where appropriate.
Unit Tests
Unit tests help your contributions last! They ensure that your code works as expected and that it continues to work in the future.
You can find examples of unit tests in the unit_test/example.rs
module.