Skip to content

main #

The Vedrock logo

Vedrock

CI Crowdin Release License

A lightweight Minecraft: Bedrock Edition server software in V.

[!NOTE]
Vedrock is currently in early development. APIs, project structure and behavior may change frequently.


Discord Banner

Getting Started

Clone Vedrock and install its dependencies:

git clone https://github.com/bedrock-v/Vedrock.git
cd Vedrock

v install

##v install --git https://github.com/bedrock-v/protocol.git
v install --git https://github.com/bedrock-v/nbt.git
v install --git https://github.com/bedrock-v/nethernet.git
v install --git https://github.com/bedrock-v/webrtc-v.git

You can develop a server directly inside the cloned repository or place one or more projects beneath it:

Vedrock/

V resolves Vedrock modules from the parent directory in this layout.

To use Vedrock from projects located elsewhere, clone it into your V modules path:

git clone https://github.com/bedrock-v/Vedrock.git \
  '$VMODULES_PATH/bedrockv/vedrock'

Vedrock modules can then be imported normally from any V project. (via bedrockv.vedrock.*)

Contributing

To contribute to Vedrock, you can open an issue or submit a pull request, and join the Discord server.

You can also consider reading the documentation to learn more about the project.

For more information, see CONTRIBUTING.md.

License

GNU Lesser v3.0