/Documentation

Documentation for Project Lodestone and various file formats and mechanics for many versions and editions of Minecraft.

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Project Lodestone - Documentation

GitHub stars GitHub forks GitHub contributors Lodestone Discord

In this repo, you'll find documentation on various mechanics and file types for many versions and editions of the game.

What is Project Lodestone?

Note

This project is still in development!

Project Lodestone is a toolset that aims to edit and convert Minecraft worlds across various editions, including Java Edition, Bedrock Edition, all 4J Studios Console (as well as 3DS) Editions, support for both current and legacy versions. Essentially a mega tool.

Note: We also have custom community-made converter support planned, but it isn't the main focus.

Join us on Discord!

View libLCE, a helper project that aims to implement LCE file support in TS

View lib3DSE, a helper project that aims to implement 3DS Edition file support in TS

Project Roadmap

We're continuously working on new features and improvements. Here's an outline of what we have planned:

World Converter

  • Start work on the World Converter
  • World Converter complete
  • Advanced conversion options:
    • Depth fixing
    • Lighting recalculation
    • Mixed output chunk versioning

World Editor

  • World Editor complete
  • Community-made modifications

Extra tools

  • NBT Editor (with S-NBT support).
  • Hex Editor
  • LevelDB Browser
  • Datapack Editor
  • Other tools:
    • Map Item Editor
    • Entity Data Editor (Inventory, Armor, Player stats, Effects, Villager trades, etc.)
    • Resource/Texture Pack Converter
    • Item NBT Editor

GRF Editor

  • GRF Editor
  • Custom resource packs & texture pack modifications.

Web UI

  • UI planned out
  • UI completed
  • Localization
  • Accessibility

Release

  • Get the web UI ready
  • Stress test

Stay tuned as we make progress on each phase. If you're interested in contributing, we welcome your input!

Supported Editions and Versions

Note: A lot of this is what to be expected, not already finished.

Edition Supported Versions
Java Edition c0.30 - 1.21
Bedrock Edition 0.1.0 - 1.21
Raspberry Pi Edition 0.1.0 - 0.1.1
Xbox 360 Edition TU0 - TU75
PlayStation 3 Edition 1.00 - 1.84
Xbox One Edition CU1 - CU59
PlayStation 4 Edition 1.00 - 1.95
PlayStation Vita Edition 1.00 - 1.84
Wii U Edition Patch 1 - Patch 43
3DS Edition 0.1.0 - 1.9.19
Switch Edition 1.0.1 - 1.0.17

Contribute to the Project

Want to help shape Project Lodestone? Here's how you can get involved:

  • Submit a Pull Request: Whether it's bug fixes, new features, or improvements, your contributions are welcome.
  • Join Our Discord: Connect with the community, discuss ideas, and get help on our Discord server.
  • Spread the Word: Star the repository, share it with others, and help grow our community!

Thank you to all the contributors who make this project possible!

Full list of contributors