WorldTools: World Downloader (Fabric / Forge)

WorldTools is a powerful Minecraft mod that allows you to capture and save high-detail snapshots of server worlds
locally.
It empowers you to download comprehensive information, including chunks, entities,
chests, players, statistics, advancements, and detailed metadata.
WorldTools ensures that you can retain an accurate and unaltered representation of the server's world for analysis,
sharing, or backup purposes on your local machine.

Features

• World Download (default keybind: F12):
  Initiate a quick download by hitting the F12 key, which can be altered in the keybind settings.
  Alternatively, you can access the GUI (default keybind: F10) via the escape menu.
  The GUI allows you to tailor the capture process according to your requirements.
  WorldTools facilitates the capture of a wide range of crucial elements, ensuring no detail is missed.

  • Chunks: Terrain, biomes and structures
  • Entities: Positions and attributes of all entities
  • Containers: Contents of all tile entities like chests, shulkers, hoppers, furnaces, brewing stands, droppers,
    dispensers etc...
  • Players: Player positions and inventories
  • Statistics: Full personal player statistics
  • Advancements: Player advancements and progress
  • Detailed Metadata: Exhaustive capture details like modt, server version, and more

• Easy Access to Saved Worlds: Your locally captured world save can be found in the single-player worlds list,
  allowing you to load and explore it conveniently.

• Advanced Configuration: WorldTools provides a wide range of settings to customize the capture process to your
  needs.
  Select elements to capture, modify game rules, alter entity NBT data, and configure the capture process in detail.

Getting Started

Fabric

1. Installation:

   • Install Fabric by following the Fabric Installation Guide.
   • Download the latest Fabric version of WorldTools from
     the releases page
   • Place the WorldTools Fabric mod JAR file in the "mods" folder of your Fabric installation.

2. Prerequisites: Make sure you have the following mods installed:

   • Fabric API
   • fabric-language-kotlin
   • Cloth Config API
   • Mod Menu

Forge

1. Installation:

   • Install Forge by following the Forge Download Link.
   • Download the latest Forge version of WorldTools from
     the releases page
   • Place the WorldTools Forge mod JAR file in the "mods" folder of your Forge installation.

2. Prerequisites: Make sure you have the following mods installed:

   • Kotlin For Forge
   • Cloth Config API

Usage

1. Download:
   • Enable capture mode: Hit F12 the GUI or /worldtools capture to start capturing data.
   • Play the game normally while WorldTools downloads the all data. You need to open containers like chests to capture
     their contents.
   • Save captured data: Hit F12 the GUI or /worldtools capture again to stop capturing data and save the world.
2. Access Downloaded World: Your downloaded world can be found in the single-player worlds list.

File Structure

After capturing data, WorldTools creates the following files in the world directory's folder:

• Capture Metadata.md: Contains detailed information about the capture process itself.

• Dimension Tree.txt: Provides a tree of all dimension folder paths of the server, not just the downloaded ones.

• Player Entry List.csv: Lists all players that were online during the capture including all known metadata.

Contributing

Contributions are welcome!
Please read our Code of Conduct
and Contributing Guidelines before submitting a
Pull Request.

1. Fork the repository and clone it to your local machine.
   git clone https://github.com/Avanatiker/WorldTools
2. Create a new branch for your feature.
   git checkout -b my-new-feature
3. Make your changes and commit them to your branch.
   git commit -am 'Add some feature'
4. Push your changes to your fork.
   git push origin my-new-feature
5. Open a Pull Request in this repository.
6. Your Pull Request will be reviewed and merged as soon as possible.
7. Wait for the next release to see your changes in action!

Building

1. Once forked and cloned, run ./gradlew build to build the mod for both mod loaders.
2. IntelliJ IDEA will generate run configurations for both mod loaders that can be used to run the mod in a test
   environment.
3. The Fabric mod JAR file can be found in fabric/build/libs and the Forge mod JAR file in forge/build/libs.

License

WorldTools is distributed under
the GNU General Public License v3.0.

If you have any questions, concerns, or suggestions,
you can visit our official Discord server.

Disclaimer: WorldTools is not affiliated with Mojang Studios. Minecraft is a registered trademark of Mojang Studios.
Use of the WorldTools software is subject to the terms outlined in the license agreement.