Skip to main content

Beet Framework made to help generating advanced Minecraft datapack contents

Project description

YouTube GitHub Documentation Lint Powered by StewBeet PMC Discord PyPI - Downloads

Tests 3.14 Tests 3.14t Tests 3.15 Tests 3.15t

โ“ What is StewBeet

StewBeet is a Beet framework and library ๐Ÿ“ฆ aiming to provide huge automation for creating Minecraft datapacks.
It is designed to be very simple to use and very convenient for developers.

Example of the in-game manual generated by StewBeet:
In-game Manual Example

Here is a list of features that the package provides (the template is using all of them with clear comments):

  • ๐Ÿ”„ Automatic resource pack files generation (models, textures, sounds, music discs) with the ability to override them with help of the assets folder.
  • โณ Versioned load, and clock functions such as tick, second, minute.
  • ๐Ÿ—ƒ๏ธ Loot tables for every item in the definitions along with a proper _give_all function that gives named chests.
  • ๐Ÿ“– Automatic generation of a really advanced and interactive items manual.
  • ๐Ÿ“ Automatic generation of a en-us.json lang file in the resource pack if configuration is set.
  • ๐Ÿ–ผ๏ธ Automatic headers for every function in function folders.
  • ๐Ÿ“ฆ Minecraft like vanilla recipes unlocking.
  • ๐Ÿ“š Official libraries integrations:
    • ๐Ÿงช Automatic support for NBT Recipes with Smithed Crafter and Furnace NBT Recipes
    • ๐Ÿ› ๏ธ Placement and destruction for every custom block in the definitions with support for blockstates, ore drops (fortune, silk touch), with Smithed Custom Blocks.
    • ๐Ÿ“š Each module from Bookshelf is automatically added if you are using it, ex: function #bs.math:... will add the bs.math module to the datapack.
    • โ›๏ธ Custom ore generation with Smart Ore Generation.
    • ๐Ÿ“ฆ Item transportation / container declaration with ItemIO when making custom containers.
    • ๐Ÿ”” Events such as new items detection with Common Signals.
  • ๐ŸŒ External datapack libraries support, see configuration for more information.
  • ๐Ÿ”— Merging datapacks and resource packs with libraries using Smithed Weld.
  • ๐Ÿงฉ Automatic recognition of custom blocks patterns depending on the texture names in the assets/textures folder. For instance, if you have a top, side, and bottom texture, the block will be automatically recognized as a cube with the top, side, and bottom textures.
  • ๐Ÿ“ Follow the datapack conventions such as LanternLoad, CustomModelData prefix, tag specification, and namespacing.
  • ๐Ÿงฐ Ability to merge a model with the autogenerated one or override it.
  • ๐Ÿ”€ merge folder providing a way to merge custom files with the autogenerated ones or add custom files to the datapack.
  • โš™๏ธ Automatic special compatibilities with datapacks such as SimpleDrawer's compacted drawer, SimplEnergy's pulverizer.
  • ๐Ÿ“‚ Automatic copy of generated zip files to configured folders.

๐Ÿ“ฆ Getting Started & Documentation

For complete installation instructions, tutorials, and comprehensive documentation, visit the official website:

๐ŸŒ stewbeet.paralya.fr

Quick links:

๐Ÿค Contribute

Want to help improve StewBeet? ๐Ÿ”
Here's how you can contribute:

  • ๐Ÿ› Report Bugs: Found a bug? Open an issue on GitHub describing what happened and how to reproduce it.
  • โœจ Suggest Features: Have an idea for a new feature? Share it in the issues section!
  • ๐Ÿ”ง Submit Pull Requests: Feel free to fix bugs or add new features by submitting pull requests.
  • ๐Ÿ“š Improve Documentation: Help make our docs better by fixing errors or adding examples.
  • ๐Ÿ’ฌ Help Others: Join our Discord server and help other users with their questions.

Every contribution matters, no matter how small! ๐Ÿ™Œ

๐Ÿ“œ What projects use StewBeet?

To search for projects that use the framework, I search like this.
Here is a list of projects that use it:

โญ Star History

Star History Chart

Project details


Release history Release notifications | RSS feed

This version

3.2.8

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stewbeet-3.2.8.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stewbeet-3.2.8-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file stewbeet-3.2.8.tar.gz.

File metadata

  • Download URL: stewbeet-3.2.8.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for stewbeet-3.2.8.tar.gz
Algorithm Hash digest
SHA256 c9aa0d3aca78c5530b05c793f19dc79330b1a5630e348c74464cc9cef66b9fa0
MD5 627466eb6425507dad46e41544deee75
BLAKE2b-256 de0e7b46b66fe362cbf25cbc509a7875125f61c270b1a5e10ff843fb8d3a39e9

See more details on using hashes here.

File details

Details for the file stewbeet-3.2.8-py3-none-any.whl.

File metadata

  • Download URL: stewbeet-3.2.8-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.2 {"installer":{"name":"uv","version":"0.11.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for stewbeet-3.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c8a5efdee499afae1a033ba81c971b97f47e613049219743dec9da89fbf16399
MD5 724841bd20e3b0e008b2ca0073d184d8
BLAKE2b-256 dea8749806806083fd5dca2653a5842de08c81f0c3ddbf879e25f7c5950a21ce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page