README

Arnis     

Arnis creates complex and accurate Minecraft Java Edition (1.21.4+), Bedrock Edition, and Luanti (Minetest) worlds that reflect real-world geography, topography, and architecture.

This free and open source project is designed to handle large-scale geographic data from the real world and generate detailed Minecraft worlds. The algorithm processes geospatial data from OpenStreetMap as well as elevation data to create an accurate Minecraft representation of terrain and architecture.
Generate your hometown, big cities, and natural landscapes with ease!

_Want mobile generation or larger map sizes? MapSmith generates worlds in your browser, no install required._

!Minecraft Preview
This GitHub page and arnismc.com are the only official project websites. Do not download Arnis from any other website.

 :keyboard: Usage

Download the latest release or compile the project on your own.

Choose your area on the map using the rectangle tool, then simply click on Start Generation!
Additionally, you can customize various generation settings, such as world scale, spawn point, or building interior generation.

 📚 Documentation



Full documentation is available in the GitHub Wiki, covering topics such as generation settings, command line usage, technical explanations, FAQs and contribution guidelines.

backgroundvid.webm

 :trophy: Open Source
 Key objectives of this project
- Modularity: Ensure that all components (e.g., data fetching, processing, and world generation) are cleanly separated into distinct modules for better maintainability and scalability.
- Performance Optimization: We aim to maintain strong performance and fast world generation.
- Comprehensive Documentation: Detailed in-code documentation for a clear structure and logic.
- User-Friendly Experience: Focus on making the project easy to use for end users.
- Cross-Platform Support: We want this project to run smoothly on Windows, macOS, and Linux.

 How to contribute
This project is open source and welcomes contributions from everyone! Whether you're interested in fixing bugs, improving performance, adding new features, or enhancing documentation, your input is valuable. Simply fork the repository, make your changes, and submit a pull request. Please respect the above-mentioned key objectives. Contributions of all levels are appreciated, and your efforts help improve this tool for everyone.

Command line Build: cargo run --release --no-default-features -- --output-dir="C:/YOUR_PATH/.minecraft/saves" --bbox="min_lat,min_lng,max_lat,max_lng"
GUI Build: cargo run --release

All command line options, like the generation modes, winter and One World, are explained on the Command Line Usage wiki page.

After your pull request is merged, I will take care of regularly creating update releases which will include your changes.

If you are using Nix, you can run the program directly with nix run github:louis-e/arnis -- --output-dir=YOUR_PATH/.minecraft/saves --bbox="min_lat,min_lng,max_lat,max_l