Documentation scraper for the Minecraft Bedrock Edition wiki.
Rewrite of the Bedrock Harvester.
This tool can be run on Minecraft base-game files, including the hosted Vanilla Packs files, or those pulled from the .apk.
Feel free to contribute, ask for new content generation or existing one update.
Maintained by Bedrock OSS organization, mostly by MJ105#0448.
- Clone repo
cd ./..pip install -r requirements.txt
cd ./..python main.py(+ args)- Provide data program asks for.
You might need to uncomment some functions in # Content generation
Default configuration (no arguments) downloads the stable version of packs. If you want to change configuration, add:
--skip_download
--download_mode ["stable" or "preview"]
Example:
- Generate docs for preview version:
python main.py --download_mode preview - Skip download (used when extracting from other resources):
python main.py --skip_download
The scripts uses temporary path packs, where vrp and vbp are downloaded. The path is not cleared after the execution, it conditionally removed and added again at the start of the script.
You can add custom data (that is not in vanilla packs) to custom_data folder. Make sure it is zipped.
Note: Last updated for version is based on min_engine_version in manifest.json, which is not always changed. Like if packs version is 1.18.31, it will still say "1.18.30".
Q: Where can I see everything what this script changes/generates? A: You can find what content this script generates in content_list.txt file.
Q: I changed local path of wiki repo, how can I fix script's target folder? A: Delete wiki_local_path.txt file or clear it and run the script again.
Q: Why 'Last updated for version' doesn't match example packs version?
A: There aren't any actual version markers in vanilla packs, so min_engine_version is used. If something new (like entity, block or important fix) is added, this version gets changes.
Q: I want to contribute to this project, where should I go? A: View CONTRIBUTING.md.