{"id":13571679,"url":"https://github.com/valence-rs/valence","last_synced_at":"2025-05-11T05:46:11.602Z","repository":{"id":58563546,"uuid":"450114994","full_name":"valence-rs/valence","owner":"valence-rs","description":"A Rust framework for building Minecraft servers.","archived":false,"fork":false,"pushed_at":"2025-03-11T04:40:55.000Z","size":5992,"stargazers_count":3003,"open_issues_count":74,"forks_count":149,"subscribers_count":37,"default_branch":"main","last_synced_at":"2025-05-11T05:46:03.690Z","etag":null,"topics":["bevy","ecs","game","gamedev","hacktoberfest","minecraft","rust","server"],"latest_commit_sha":null,"homepage":"http://valence.rs/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/valence-rs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"rj00a","patreon":"rj00a"}},"created_at":"2022-01-20T13:47:27.000Z","updated_at":"2025-05-10T16:29:06.000Z","dependencies_parsed_at":"2022-09-06T05:42:40.966Z","dependency_job_id":"5ec90be2-7d91-4e66-a49b-93edecca2fa5","html_url":"https://github.com/valence-rs/valence","commit_stats":{"total_commits":607,"total_committers":63,"mean_commits":9.634920634920634,"dds":0.3640856672158155,"last_synced_commit":"76fb18f185913a9279862a3084787b2afeb514f2"},"previous_names":["rj00a/valence"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valence-rs%2Fvalence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valence-rs%2Fvalence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valence-rs%2Fvalence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/valence-rs%2Fvalence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/valence-rs","download_url":"https://codeload.github.com/valence-rs/valence/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253523720,"owners_count":21921818,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bevy","ecs","game","gamedev","hacktoberfest","minecraft","rust","server"],"created_at":"2024-08-01T14:01:04.882Z","updated_at":"2025-05-11T05:46:11.577Z","avatar_url":"https://github.com/valence-rs.png","language":"Rust","funding_links":["https://github.com/sponsors/rj00a","https://patreon.com/rj00a","https://www.patreon.com/rj00a"],"categories":["Rust","Tools"],"sub_categories":["Other Libraries"],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/valence-rs/valence/main/assets/logo-full.svg\" width=\"650\" align=\"center\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/valence-rs/valence/blob/main/LICENSE.txt\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/valence-rs/valence\"\n            alt=\"license\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://crates.io/crates/valence\"\u003e\n      \u003cimg src=\"https://img.shields.io/crates/d/valence?label=crates.io\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://discord.gg/8Fqqy9XrYb\"\u003e\n        \u003cimg src=\"https://img.shields.io/discord/998132822239870997?logo=discord\"\n            alt=\"chat on Discord\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/sponsors/rj00a\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/sponsors/rj00a\"\n            alt=\"GitHub sponsors\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nA Rust framework for building Minecraft: Java Edition servers.\n\nBuilt on top of [Bevy ECS](https://bevyengine.org/learn/book/getting-started/ecs/), Valence is an effort to create a\nMinecraft compatible server completely from scratch in Rust. You can think of Valence as a _game engine for\nMinecraft servers_. It doesn't do much by default, but by writing game logic yourself and leveraging Bevy's\npowerful [plugin system](https://bevyengine.org/learn/book/getting-started/plugins/), you can make almost anything.\n\nOpinionated features like dynamic scripting, dedicated executables, and vanilla game mechanics are all expected to be\nbuilt as optional plugins. This level of modularity is desirable for those looking to build highly custom experiences\nin Minecraft such as minigame servers.\n\n⚠️ **Valence is still early in development with many features unimplemented or incomplete. Expect to encounter bugs, limitations, and breaking changes.**\n\n# Goals\n\nValence aims to be the following:\n\n* **Complete**. Abstractions for the full breadth of the Minecraft protocol.\n* **Flexible**. Can easily extend Valence from within user code. Direct access to the Minecraft protocol is provided.\n* **Modular**. Pick and choose the components you need.\n* **Intuitive**. An API that is easy to use and difficult to misuse. Extensive documentation and examples are important.\n* **Efficient**. Optimal use of system resources with multiple CPU cores in mind. Valence uses very little memory and\n  can\n  support [thousands](https://raw.githubusercontent.com/valence-rs/valence/main/assets/many-players.png)\n  of players at the same time without lag (assuming you have the bandwidth).\n* **Up to date**. Targets the most recent stable version of Minecraft. Support for multiple versions at once is not\n  planned. However, you can use a proxy with [ViaBackwards](https://www.spigotmc.org/resources/viabackwards.27448/) to\n  achieve backwards compatibility with older clients.\n\n## Current Status\n\nHere are some noteworthy achievements:\n- `valence_nbt`: A speedy new library for Minecraft's Named Binary Tag (NBT) format.\n- Authentication, encryption, and compression\n- Block states\n- Chunks\n- Entities and metadata\n- Bounding volume hierarchy for fast spatial entity queries\n- Player list and player skins\n- Dimensions, biomes, and worlds\n- JSON Text API\n- A Fabric mod for extracting data from the game into JSON files. These files are processed by a build script to\n  generate Rust code for the project. The JSON files can be used in other projects as well.\n- Inventories\n- Items\n- Particles\n- Anvil file format (read only)\n- Proxy support ([Velocity](https://velocitypowered.com/), [Bungeecord](https://www.spigotmc.org/wiki/bungeecord/)\n  and [Waterfall](https://docs.papermc.io/waterfall))\n\nHere is a [short video](https://www.youtube.com/watch?v=jkw9fZx9Etg) showing the examples and some of\nValence's capabilities.\n\n# Getting Started\n\n## Running the Examples\n\nAfter cloning the repository, run this command to try an example.\n\n```shell\ncargo r -r --example parkour\n```\n\n I also recommend giving `game_of_life`, `terrain`, and `cow_sphere` a try.\n\nNext, open your Minecraft client and connect to the address `localhost`.\nIf all goes well you should be playing on the server.\n\n## Adding Valence as a Dependency\n\nValence is published to [crates.io](https://crates.io/crates/valence). Run `cargo add valence` to add it to your\nproject.\n\nHowever, the crates.io version is likely outdated. To use the most recent development version, add Valence as a\n[git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).\n\n```toml\n[dependencies]\nvalence = { git = \"https://github.com/valence-rs/valence\" }\n```\n\nDocumentation from the main branch is available [here](https://valence.rs/rustdoc/valence/).\n\n# Contributing\n\nContributions are welcome! Please\nsee [CONTRIBUTING.md](https://github.com/valence-rs/valence/blob/main/CONTRIBUTING.md). You can\njoin [Discord](https://discord.gg/8Fqqy9XrYb) or [GitHub Discussions](https://github.com/valence-rs/valence/discussions)\nto discuss the project and ask questions.\n\n# License\n\nCode is licensed under [MIT](https://opensource.org/licenses/MIT) while the Valence logo is\nunder [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)\n\n# Funding\n\nIf you would like to contribute financially, consider sponsoring me (rj00a)\non [GitHub](https://github.com/sponsors/rj00a)\nor [Patreon](https://www.patreon.com/rj00a).\n\nI would love to continue working on Valence and your support would help me do that. Thanks!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalence-rs%2Fvalence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvalence-rs%2Fvalence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvalence-rs%2Fvalence/lists"}