Rust library for creating Minecraft datapacks
Go to file
Moritz Hölting d9e3184a0e implement validate function for checking the pack format compatibility 2024-06-18 20:50:00 +02:00
examples change tag creation behaviour 2024-06-18 15:38:23 +02:00
src implement validate function for checking the pack format compatibility 2024-06-18 20:50:00 +02:00
.gitignore add tracing crate for logging 2024-06-15 21:46:47 +02:00
CHANGELOG.md implement validate function for checking the pack format compatibility 2024-06-18 20:50:00 +02:00
Cargo.toml add tracing crate for logging 2024-06-15 21:46:47 +02:00
LICENSE.txt update project metadata and license information 2024-06-10 10:27:34 +02:00
README.md add contributing section to readme 2024-06-10 16:27:24 +02:00

README.md

Shulkerbox-rs

Create datapacks with all the features of rust you like.

Usage

Add the following to your dependencies in Cargo.toml:

[dependencies]
shulkerbox = { git = "https://github.com/moritz-hoelting/shulkerbox" }

Example Usage

use shulkerbox::{
    datapack::{Datapack, Function, Namespace},
    util::compile::CompileOptions,
};

let mut dp = Datapack::new("shulkerpack", 20) // Create a new datapack with the name "shulkerpack" and the pack format 20
    .with_description("I created this datapack with rust") // Add a description to the datapack
    .with_supported_formats(16..=20) // Add the supported formats of the datapack
    .with_template_folder(Path::new("./template")) // Add a template folder to the datapack. This will include all files in the template folder in the root of the datapack and can be used for including the "pack.png" file
    .unwrap();
let namespace = datapack.namespace_mut("shulker"); // Create a new namespace with the name "shulker"

let hello_function = namespace.function_mut("hello"); // Create a new function
hello_function.add_command("say Hello, world!"); // Add a command to the function

let v_folder = dp.compile(&CompileOptions::default()); // Compile the datapack with default options

v_folder.place(Path::new("./dist")).unwrap(); // Place the datapack in the dist folder
v_folder.zip(Path::new("./dist.zip")).unwrap(); // Zip the datapack to the dist.zip file

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.