stewbeet 2.2.31__tar.gz

stewbeet-2.2.31/.gitignore

@@ -0,0 +1,11 @@
+
+env
+venv
+.env
+.venv
+__pycache__
+extensive_template/continuous_delivery/
+upload.py
+perf.html
+.beet_cache
+

stewbeet-2.2.31/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alexandre Collignon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

stewbeet-2.2.31/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: stewbeet
+Version: 2.2.31
+Summary: Beet Framework made to help generating advanced Minecraft datapack contents
+Project-URL: Homepage, https://github.com/Stoupy51/stewbeet
+Project-URL: Issues, https://github.com/Stoupy51/stewbeet/issues
+Author-email: Stoupy51 <stoupy51@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: beet>=0.112.0
+Requires-Dist: bolt>=0.49.2
+Requires-Dist: mecha>=0.99.0
+Requires-Dist: model-resolver>=1.12.0
+Requires-Dist: mutagen>=1.47.0
+Requires-Dist: pydantic<2.12.0
+Requires-Dist: pyperclip>=1.8.0
+Requires-Dist: smithed>=0.19.0
+Requires-Dist: stouputils>=1.5.0
+Description-Content-Type: text/markdown
+
+
+[![YouTube](https://img.shields.io/youtube/views/zkcQn23DRaw?style=flat&logo=youtube&logoColor=red&label=YouTube)](https://www.youtube.com/watch?v=zkcQn23DRaw)
+[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stewbeet?logo=github&label=GitHub)](https://github.com/Stoupy51/stewbeet/releases/latest)
+[![PMC](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.planetminecraft.com%2Fdata-pack%2Fpython-datapack%2Fstatsv2&query=%24.downloads&logo=data%3Aimage%2Fvnd.microsoft.icon%3Bbase64%2CAAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAABMLAAATCwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJdNAUBLJgD%2FSyYA%2FxkoD%2F8vKAn%2Fl00BgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2FwAAAP8AAAD%2FmVgI%2F0tcHf8CXjP%2FL10l%2FwAAAP8AAAD%2FAAAA%2FwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2F5VOAf%2BVTQH%2FfVkP%2FyZ%2BOv8BgET%2FAYBE%2FwGARP9LZyP%2FlU0B%2F5ZNAf8AAAD%2FAAAAAAAAAAAAAAAAAAAAAJVOAf%2FYeRL%2F64wl%2F7eZOP8Bo1f%2FAaNW%2FwGjVv88nkv%2F2oEb%2F9N0Df%2FTdA3%2FlU0B%2F5dNAUAAAAAAAAAAAAAAAACkVQH%2F3pAq%2F6CcOv92pUf%2FLLli%2F12zW%2F%2FBqEv%2Fy59B%2F%2B2OJ%2F%2Figxz%2F03QN%2F5VNAf%2BEUARAAAAAAAAAAAAAAAD%2FjoMq%2Fzi2XP96r1T%2F3ahG%2F%2BCvUP%2F9qkr%2F%2F6hL%2F%2F2kRP%2F2mTT%2F7Y4n%2F%2BCBGv93aRf%2FAAAA%2FwAAAAAAAAAAp1gB%2FxHEb%2F%2BlslX%2F36xL%2F9StTP%2F%2Fp0f%2F%2F6VE%2F%2F%2BqTv%2F%2Fqk7%2F%2FaVH%2F%2FecOf%2Ftjif%2FMIQ3%2FwNhMP8AAAAAAAAAAI9bA%2F8SxXD%2FHr5o%2Fzm8ZP%2Fvo0D%2F%2F6I9%2F%2F%2BiPf%2F%2Fq1D%2F%2F6tQ%2F%2F%2BrUP%2F7pEb%2F7Y4n%2FwGCQf8BYDD%2FAAAAAAAAAAB8Wgz%2FFMdy%2FxDDbv8Qw27%2Fh7Zd%2F%2F%2BnSP%2F%2Foj3%2F%2F6xS%2F%2F%2BsUv%2F%2Fp0j%2F%2B504%2F%2B2OJ%2F%2BUfyH%2FAWIw%2FwAAAAAAAAAAelsL%2Fwa2Y%2F8TxnH%2FieK4%2F9fu2P%2F%2F2rH%2F%2F6pN%2F%2F%2BlQv%2F%2FpUL%2F%2F6NA%2F%2F2fOv%2F1li%2F%2FlH8h%2FwJhMP8AAAAAqVcBQIFaCkABczz%2FFMdy%2F7Hs0P%2F%2F%2F%2F%2F%2F6O7W%2F9SyV%2F%2F%2Foj3%2F%2F6RC%2F%2FidOv%2Fxkyz%2FxJEw%2F01fGf8hWR1wAVQqQAAAAAAAAAAAAV4y%2Fw2%2Fa%2F%2Bs16b%2F1OfK%2F7%2Fdr%2F%2F%2BrFH%2F%2F6RB%2F%2F%2BmRv%2F2mzn%2F2Y4p%2F2qOOP8BVCr%2FJDorQAAAAAAAAAAAAAAAAAFeMv8BsF7%2FLbpl%2F0DAaP%2Bmtlz%2Fo7Vc%2F%2F%2BoS%2F%2F%2FqEv%2F9ps6%2FyeOQf8BjUb%2FAlQq%2FwFUKkAAAAAAAAAAAAAAAAAAAAAAAl0z%2FxheKf8PdTL%2FeqxN%2FyvDaf%2F8rVL%2Fz6dF%2F7R6H%2F8BXS7%2FAlQq%2FwdRKwIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABGUCICeF4GQGNfDP9sXwj%2FqFgB%2F4hbB%2F9DWiKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKpXAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2FB8AAOAHAADAAwAAwAMAAMADAACAAQAAgAEAAIABAACAAQAAgAEAAMADAADAAwAAwAMAAOAHAAD8H%2F%2F%2F%2F%2F%2F%2F%2Fw%3D%3D&label=PMC&color=6ec310)](https://www.planetminecraft.com/data-pack/python-datapack/)
+[![Discord](https://img.shields.io/discord/1216400498488377467?label=Discord&logo=discord)](https://discord.gg/anxzu6rA9F)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stewbeet?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stewbeet/)
+
+
+## ❓ What is `StewBeet`
+`StewBeet` is a [Beet](https://github.com/mcbeet/beet) framework and library 📦 aiming to provide huge automation for creating Minecraft datapacks.<br>
+It is designed to be very simple to use and very convenient for developers.
+
+`Example of the in-game manual generated by StewBeet:`<br>
+![In-game Manual Example](https://i.imgur.com/dtuAG99.gif)
+
+
+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`](./assets/in_game_manual_example.png).
+- 📝 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`](https://wiki.smithed.dev/libraries/crafter/) and [`Furnace NBT Recipes`](https://github.com/Stoupy51/FurnaceNbtRecipes/)
+  - 🛠️ Placement and destruction for every custom block in the `definitions` with support for blockstates, ore drops (fortune, silk touch), with [`Smithed Custom Blocks`](https://wiki.smithed.dev/libraries/custom-block/).
+  - 📚 Each module from [`Bookshelf`](https://github.com/mcbookshelf/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`](https://github.com/Stoupy51/SmartOreGeneration).
+  - 📦 Item transportation / container declaration with [`ItemIO`](https://github.com/edayot/ItemIO) when making custom containers.
+  - 🔔 Events such as new items detection with [`Common Signals`](https://github.com/Stoupy51/CommonSignals).
+- 🌐 External datapack libraries support, see configuration for more information.
+- 🔗 Merging datapacks and resource packs with libraries using [Smithed Weld](https://weld.smithed.dev/).
+- 🧩 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](https://github.com/LanternMC/load), [CustomModelData prefix](https://mcdatapack.vercel.app/), [tag specification](https://wiki.smithed.dev/conventions/tag-specification/), and [namespacing](https://wiki.smithed.dev/conventions/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`](https://edayot.github.io/SimpleDrawer/material.html), [`SimplEnergy's pulverizer`](./build/datapack/data/your_namespace/function/calls/simplenergy/pulverizer_recipes.mcfunction).
+- 📂 Automatic copy of generated zip files to configured folders.
+
+
+## 📦 How to use (beginner friendly)
+In order to use `StewBeet`, you need to have at least [Python 3.12](https://www.python.org/downloads/) 🐍 or higher installed on your computer with pip!<br>
+Then, you can open a terminal 💻 and run the following command to install the python package:
+
+```bash
+# This will install the latest version of the framework
+# (including beet, bolt, mecha, and other dependencies)
+pip install stewbeet
+```
+
+Next, there are a few templates available in the [`./templates`](./templates/) folder 📁,<br>
+There are 3 templates available, feel free to choose the one you prefer (but I highly recommend the basic template):
+- 🔹 [`minimal template`](./templates/minimal_template.zip): A very minimal template using only one `stewbeet` plugin.
+- ⭐ [`basic template`](./templates/basic_template.zip): A template with complete configuration but no coded features.
+- 🌟 [`extensive template`](./templates/extensive_template.zip): A template with all the features of the framework, including all the plugins.
+
+The clickable links are zip files 📦, but you can check the content of the templates in the [`./templates`](./templates/) folder.<br>
+
+Once you have a template, you can modify the `beet.yml` configuration file ⚙️ to suit your needs.<br>
+Finally, you can run the following command to build the project 🔨:
+
+```bash
+# You can also run 'beet' instead of 'stewbeet' but with less functionality
+# (Make sure you are in the project folder)
+stewbeet
+```
+The command will generate a datapack and a resource pack in your `build` folder 🏗️.<br>
+And that's it! 🎉 That is this easy use the package.<br>
+Since this template is using all the features of the package, you can remove the parts you don't need! 🧹
+
+## 🌱 How to use (Beet users)
+If you are already familiar with the [Beet](https://github.com/mcbeet/beet) development kit, `StewBeet` is developped as a bunch of plugins for it.<br>
+Install `StewBeet` with `pip install stewbeet` and check the [StewBeet plugins documentation](./docs/plugins/README.md) to learn about them.
+
+
+## 📚 Documentation
+There are a lot of features in the package, you could check the [extensive template](./templates/extensive/) to see how to use them.<br>
+Alternatively, you could join the [Discord server](https://discord.gg/anxzu6rA9F) to ask questions and get help from the community!<br>
+Or, you could check the **highly detailed** [documentation folder](docs/)<br>
+Here a list of all the currently available guides:
+- 📖 [Getting started](docs/0_getting_started/README.md)
+- 🌱 [Beet Plugins](docs/plugins/README.md)
+- 📁 [Project structure](docs/1_project_structure.md)
+- 🗄️ [Database setup](docs/2_definitions_setup.md)
+- ✍️ [Writing to files](docs/3_writing_to_files.md)
+- 🔗 [External dependencies](docs/4_external_dependencies.md)
+- 🔧 [Miscellaneous](docs/5_miscellaneous.md)
+- 🔄 [Migration guide](docs/6_migration_guide.md)
+- 🚀 [Continuous delivery](docs/7_continuous_delivery.md)
+- ⚔️ [Adding a sword](docs/specific_guides/adding_a_sword.md)
+- More soon!
+
+
+## 🤝 Contribute
+Want to help improve StewBeet? 🔍<br>
+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](https://discord.gg/anxzu6rA9F) 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.](https://github.com/search?q=%22%5C%22stewbeet.plugins.%22&type=code)<br>
+Here is a list of projects that use it:<br>
+- Actual projects:
+  - Your next project here!
+  - https://github.com/e-psi-lon/Armored-Elytra (Python Datapack: before Stewbeet was a thing)
+  - https://github.com/Stoupy51/SimplEnergy
+  - https://github.com/Stoupy51/ImagineYourCraftDatapack
+  - https://github.com/Stoupy51/LifeSteal
+  - https://github.com/Stoupy51/Survisland
+  - https://github.com/Stoupy51/SmithedSummit
+  - https://github.com/Stoupy51/SheepWars
+  - https://github.com/Stoupy51/MoreApples
+  - https://github.com/Stoupy51/CauldronConcretePowder
+
+- Libraries or tools:
+  - https://github.com/Stoupy51/SmartOreGeneration
+  - https://github.com/Stoupy51/CommonSignals
+
+
+## ⭐ Star History
+
+<html>
+  <a href="https://star-history.com/#Stoupy51/StewBeet&Date">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/StewBeet&type=Date&theme=dark" />
+      <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/StewBeet&type=Date" />
+      <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/StewBeet&type=Date" />
+    </picture>
+  </a>
+</html>
+

stewbeet-2.2.31/README.md

@@ -0,0 +1,139 @@
+
+[![YouTube](https://img.shields.io/youtube/views/zkcQn23DRaw?style=flat&logo=youtube&logoColor=red&label=YouTube)](https://www.youtube.com/watch?v=zkcQn23DRaw)
+[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stewbeet?logo=github&label=GitHub)](https://github.com/Stoupy51/stewbeet/releases/latest)
+[![PMC](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fwww.planetminecraft.com%2Fdata-pack%2Fpython-datapack%2Fstatsv2&query=%24.downloads&logo=data%3Aimage%2Fvnd.microsoft.icon%3Bbase64%2CAAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAABMLAAATCwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAJdNAUBLJgD%2FSyYA%2FxkoD%2F8vKAn%2Fl00BgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2FwAAAP8AAAD%2FmVgI%2F0tcHf8CXjP%2FL10l%2FwAAAP8AAAD%2FAAAA%2FwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2F5VOAf%2BVTQH%2FfVkP%2FyZ%2BOv8BgET%2FAYBE%2FwGARP9LZyP%2FlU0B%2F5ZNAf8AAAD%2FAAAAAAAAAAAAAAAAAAAAAJVOAf%2FYeRL%2F64wl%2F7eZOP8Bo1f%2FAaNW%2FwGjVv88nkv%2F2oEb%2F9N0Df%2FTdA3%2FlU0B%2F5dNAUAAAAAAAAAAAAAAAACkVQH%2F3pAq%2F6CcOv92pUf%2FLLli%2F12zW%2F%2FBqEv%2Fy59B%2F%2B2OJ%2F%2Figxz%2F03QN%2F5VNAf%2BEUARAAAAAAAAAAAAAAAD%2FjoMq%2Fzi2XP96r1T%2F3ahG%2F%2BCvUP%2F9qkr%2F%2F6hL%2F%2F2kRP%2F2mTT%2F7Y4n%2F%2BCBGv93aRf%2FAAAA%2FwAAAAAAAAAAp1gB%2FxHEb%2F%2BlslX%2F36xL%2F9StTP%2F%2Fp0f%2F%2F6VE%2F%2F%2BqTv%2F%2Fqk7%2F%2FaVH%2F%2FecOf%2Ftjif%2FMIQ3%2FwNhMP8AAAAAAAAAAI9bA%2F8SxXD%2FHr5o%2Fzm8ZP%2Fvo0D%2F%2F6I9%2F%2F%2BiPf%2F%2Fq1D%2F%2F6tQ%2F%2F%2BrUP%2F7pEb%2F7Y4n%2FwGCQf8BYDD%2FAAAAAAAAAAB8Wgz%2FFMdy%2FxDDbv8Qw27%2Fh7Zd%2F%2F%2BnSP%2F%2Foj3%2F%2F6xS%2F%2F%2BsUv%2F%2Fp0j%2F%2B504%2F%2B2OJ%2F%2BUfyH%2FAWIw%2FwAAAAAAAAAAelsL%2Fwa2Y%2F8TxnH%2FieK4%2F9fu2P%2F%2F2rH%2F%2F6pN%2F%2F%2BlQv%2F%2FpUL%2F%2F6NA%2F%2F2fOv%2F1li%2F%2FlH8h%2FwJhMP8AAAAAqVcBQIFaCkABczz%2FFMdy%2F7Hs0P%2F%2F%2F%2F%2F%2F6O7W%2F9SyV%2F%2F%2Foj3%2F%2F6RC%2F%2FidOv%2Fxkyz%2FxJEw%2F01fGf8hWR1wAVQqQAAAAAAAAAAAAV4y%2Fw2%2Fa%2F%2Bs16b%2F1OfK%2F7%2Fdr%2F%2F%2BrFH%2F%2F6RB%2F%2F%2BmRv%2F2mzn%2F2Y4p%2F2qOOP8BVCr%2FJDorQAAAAAAAAAAAAAAAAAFeMv8BsF7%2FLbpl%2F0DAaP%2Bmtlz%2Fo7Vc%2F%2F%2BoS%2F%2F%2FqEv%2F9ps6%2FyeOQf8BjUb%2FAlQq%2FwFUKkAAAAAAAAAAAAAAAAAAAAAAAl0z%2FxheKf8PdTL%2FeqxN%2FyvDaf%2F8rVL%2Fz6dF%2F7R6H%2F8BXS7%2FAlQq%2FwdRKwIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABGUCICeF4GQGNfDP9sXwj%2FqFgB%2F4hbB%2F9DWiKAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKpXAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA%2FB8AAOAHAADAAwAAwAMAAMADAACAAQAAgAEAAIABAACAAQAAgAEAAMADAADAAwAAwAMAAOAHAAD8H%2F%2F%2F%2F%2F%2F%2F%2Fw%3D%3D&label=PMC&color=6ec310)](https://www.planetminecraft.com/data-pack/python-datapack/)
+[![Discord](https://img.shields.io/discord/1216400498488377467?label=Discord&logo=discord)](https://discord.gg/anxzu6rA9F)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stewbeet?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stewbeet/)
+
+
+## ❓ What is `StewBeet`
+`StewBeet` is a [Beet](https://github.com/mcbeet/beet) framework and library 📦 aiming to provide huge automation for creating Minecraft datapacks.<br>
+It is designed to be very simple to use and very convenient for developers.
+
+`Example of the in-game manual generated by StewBeet:`<br>
+![In-game Manual Example](https://i.imgur.com/dtuAG99.gif)
+
+
+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`](./assets/in_game_manual_example.png).
+- 📝 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`](https://wiki.smithed.dev/libraries/crafter/) and [`Furnace NBT Recipes`](https://github.com/Stoupy51/FurnaceNbtRecipes/)
+  - 🛠️ Placement and destruction for every custom block in the `definitions` with support for blockstates, ore drops (fortune, silk touch), with [`Smithed Custom Blocks`](https://wiki.smithed.dev/libraries/custom-block/).
+  - 📚 Each module from [`Bookshelf`](https://github.com/mcbookshelf/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`](https://github.com/Stoupy51/SmartOreGeneration).
+  - 📦 Item transportation / container declaration with [`ItemIO`](https://github.com/edayot/ItemIO) when making custom containers.
+  - 🔔 Events such as new items detection with [`Common Signals`](https://github.com/Stoupy51/CommonSignals).
+- 🌐 External datapack libraries support, see configuration for more information.
+- 🔗 Merging datapacks and resource packs with libraries using [Smithed Weld](https://weld.smithed.dev/).
+- 🧩 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](https://github.com/LanternMC/load), [CustomModelData prefix](https://mcdatapack.vercel.app/), [tag specification](https://wiki.smithed.dev/conventions/tag-specification/), and [namespacing](https://wiki.smithed.dev/conventions/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`](https://edayot.github.io/SimpleDrawer/material.html), [`SimplEnergy's pulverizer`](./build/datapack/data/your_namespace/function/calls/simplenergy/pulverizer_recipes.mcfunction).
+- 📂 Automatic copy of generated zip files to configured folders.
+
+
+## 📦 How to use (beginner friendly)
+In order to use `StewBeet`, you need to have at least [Python 3.12](https://www.python.org/downloads/) 🐍 or higher installed on your computer with pip!<br>
+Then, you can open a terminal 💻 and run the following command to install the python package:
+
+```bash
+# This will install the latest version of the framework
+# (including beet, bolt, mecha, and other dependencies)
+pip install stewbeet
+```
+
+Next, there are a few templates available in the [`./templates`](./templates/) folder 📁,<br>
+There are 3 templates available, feel free to choose the one you prefer (but I highly recommend the basic template):
+- 🔹 [`minimal template`](./templates/minimal_template.zip): A very minimal template using only one `stewbeet` plugin.
+- ⭐ [`basic template`](./templates/basic_template.zip): A template with complete configuration but no coded features.
+- 🌟 [`extensive template`](./templates/extensive_template.zip): A template with all the features of the framework, including all the plugins.
+
+The clickable links are zip files 📦, but you can check the content of the templates in the [`./templates`](./templates/) folder.<br>
+
+Once you have a template, you can modify the `beet.yml` configuration file ⚙️ to suit your needs.<br>
+Finally, you can run the following command to build the project 🔨:
+
+```bash
+# You can also run 'beet' instead of 'stewbeet' but with less functionality
+# (Make sure you are in the project folder)
+stewbeet
+```
+The command will generate a datapack and a resource pack in your `build` folder 🏗️.<br>
+And that's it! 🎉 That is this easy use the package.<br>
+Since this template is using all the features of the package, you can remove the parts you don't need! 🧹
+
+## 🌱 How to use (Beet users)
+If you are already familiar with the [Beet](https://github.com/mcbeet/beet) development kit, `StewBeet` is developped as a bunch of plugins for it.<br>
+Install `StewBeet` with `pip install stewbeet` and check the [StewBeet plugins documentation](./docs/plugins/README.md) to learn about them.
+
+
+## 📚 Documentation
+There are a lot of features in the package, you could check the [extensive template](./templates/extensive/) to see how to use them.<br>
+Alternatively, you could join the [Discord server](https://discord.gg/anxzu6rA9F) to ask questions and get help from the community!<br>
+Or, you could check the **highly detailed** [documentation folder](docs/)<br>
+Here a list of all the currently available guides:
+- 📖 [Getting started](docs/0_getting_started/README.md)
+- 🌱 [Beet Plugins](docs/plugins/README.md)
+- 📁 [Project structure](docs/1_project_structure.md)
+- 🗄️ [Database setup](docs/2_definitions_setup.md)
+- ✍️ [Writing to files](docs/3_writing_to_files.md)
+- 🔗 [External dependencies](docs/4_external_dependencies.md)
+- 🔧 [Miscellaneous](docs/5_miscellaneous.md)
+- 🔄 [Migration guide](docs/6_migration_guide.md)
+- 🚀 [Continuous delivery](docs/7_continuous_delivery.md)
+- ⚔️ [Adding a sword](docs/specific_guides/adding_a_sword.md)
+- More soon!
+
+
+## 🤝 Contribute
+Want to help improve StewBeet? 🔍<br>
+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](https://discord.gg/anxzu6rA9F) 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.](https://github.com/search?q=%22%5C%22stewbeet.plugins.%22&type=code)<br>
+Here is a list of projects that use it:<br>
+- Actual projects:
+  - Your next project here!
+  - https://github.com/e-psi-lon/Armored-Elytra (Python Datapack: before Stewbeet was a thing)
+  - https://github.com/Stoupy51/SimplEnergy
+  - https://github.com/Stoupy51/ImagineYourCraftDatapack
+  - https://github.com/Stoupy51/LifeSteal
+  - https://github.com/Stoupy51/Survisland
+  - https://github.com/Stoupy51/SmithedSummit
+  - https://github.com/Stoupy51/SheepWars
+  - https://github.com/Stoupy51/MoreApples
+  - https://github.com/Stoupy51/CauldronConcretePowder
+
+- Libraries or tools:
+  - https://github.com/Stoupy51/SmartOreGeneration
+  - https://github.com/Stoupy51/CommonSignals
+
+
+## ⭐ Star History
+
+<html>
+  <a href="https://star-history.com/#Stoupy51/StewBeet&Date">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/StewBeet&type=Date&theme=dark" />
+      <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/StewBeet&type=Date" />
+      <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/StewBeet&type=Date" />
+    </picture>
+  </a>
+</html>
+

stewbeet-2.2.31/pyproject.toml

@@ -0,0 +1,82 @@
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "stewbeet"
+version = "2.2.31"
+description = "Beet Framework made to help generating advanced Minecraft datapack contents"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+classifiers = [
+	"Programming Language :: Python :: 3",
+	"License :: OSI Approved :: MIT License",
+	"Operating System :: OS Independent",
+]
+dependencies = [
+	"stouputils>=1.5.0",
+	"model_resolver>=1.12.0",
+	"beet>=0.112.0",
+	"bolt>=0.49.2",
+	"mecha>=0.99.0",
+	"smithed>=0.19.0",
+	"mutagen>=1.47.0",
+	"pyperclip>=1.8.0",
+	"pydantic<2.12.0",
+]
+[[project.authors]]
+name = "Stoupy51"
+email = "stoupy51@gmail.com"
+
+[project.urls]
+Homepage = "https://github.com/Stoupy51/stewbeet"
+Issues = "https://github.com/Stoupy51/stewbeet/issues"
+
+[project.scripts]
+stewbeet = "stewbeet:main"
+
+[tool.pyright]
+typeCheckingMode = "strict"
+
+[tool.setuptools]
+license-files = ["LICENSE"]
+
+[tool.ruff]
+exclude = [
+	".git",
+	".ruff_cache",
+	".venv",
+	".vscode",
+	".cursor",
+	"build",
+	"dist",
+]
+line-length = 200
+
+[tool.ruff.lint]
+select = [
+	"E",
+	"W",
+	"F",
+	"I",
+	"N",
+	"UP",
+	"B",
+	"C4",
+	"T20",
+	"RUF",
+]
+ignore = [
+	"T201",
+	"W191",
+	"N803",
+	"N806",
+	"F403",
+	"F405",
+]
+
+[tool.hatch.build]
+include = ["stewbeet"]
+

stewbeet-2.2.31/stewbeet/__init__.py

@@ -0,0 +1,17 @@
+
+# type: ignore
+# ruff: noqa: F401
+# Imports
+from beet import *
+
+from .cli import main
+from .core import *
+from .plugins.initialize.source_lore_font import find_pack_png
+from .plugins.resource_pack.item_models.object import AutoModel
+from .plugins.resource_pack.sounds import add_sound
+
+
+def beet_default(ctx: Context):
+    """ Initializes the StewBeet package. """
+    ctx.require("stewbeet.plugins.initialize")
+

stewbeet-2.2.31/stewbeet/__main__.py

@@ -0,0 +1,7 @@
+
+# Imports
+from .cli import main
+
+if __name__ == "__main__":
+    main()
+

stewbeet-2.2.31/stewbeet/all.py

@@ -0,0 +1,53 @@
+
+# Imports
+from beet import Context
+
+# Constants
+GENERATION_PLUGINS = (
+    "stewbeet.plugins.verify_definitions",
+    "stewbeet.plugins.resource_pack.sounds",
+    "stewbeet.plugins.resource_pack.item_models",
+    "stewbeet.plugins.resource_pack.check_power_of_2",
+    "stewbeet.plugins.custom_recipes",
+    "stewbeet.plugins.custom_paintings",
+    "stewbeet.plugins.ingame_manual",
+    "stewbeet.plugins.datapack.loading",
+    "stewbeet.plugins.datapack.custom_blocks",
+    "stewbeet.plugins.datapack.loot_tables",
+    "stewbeet.plugins.datapack.sorters",
+    "stewbeet.plugins.compatibilities.simpledrawer",
+    "stewbeet.plugins.compatibilities.neo_enchant"
+)
+FINALYZE_PLUGINS = (
+    "stewbeet.plugins.finalyze.custom_blocks_ticking",
+    "stewbeet.plugins.finalyze.basic_datapack_structure",
+    "stewbeet.plugins.finalyze.dependencies",
+    "stewbeet.plugins.finalyze.check_unused_textures",
+    "stewbeet.plugins.finalyze.last_final",
+    "stewbeet.plugins.auto.lang_file",
+    "stewbeet.plugins.auto.headers",
+    "stewbeet.plugins.archive",
+    "stewbeet.plugins.merge_smithed_weld",
+    "stewbeet.plugins.copy_to_destination",
+    "stewbeet.plugins.compute_sha1"
+)
+
+def beet_default(ctx: Context):
+    """ Run all plugins that should run after definitions are loaded.
+    This function will yield before finalizing the project (so users can run their own plugins in the middle of the pipeline).
+
+    Requires:
+        - StewBeet to be initialized (e.g. from stewbeet.plugins.initialize).
+        - Definitions to be loaded
+    """
+    # Assertions
+    for x in GENERATION_PLUGINS:
+        ctx.require(x)
+
+    # Yield to allow user code to run
+    yield
+
+    # After user code, run the final plugins
+    for x in FINALYZE_PLUGINS:
+        ctx.require(x)
+

stewbeet-2.2.31/stewbeet/cli.py

@@ -0,0 +1,79 @@
+
+# Imports
+import importlib
+import os
+import shutil
+import subprocess
+import sys
+
+from beet import ProjectConfig
+from stouputils.decorators import LogLevels, handle_error
+from stouputils.print import GREEN, RED, info, show_version
+
+from .utils import get_project_config
+
+
+@handle_error(message="Error while running 'stewbeet'")
+def main():
+    second_arg: str = sys.argv[1].lower() if len(sys.argv) == 2 else ""
+    if second_arg == "" and len(sys.argv) == 1:
+        sys.argv.append("build")
+
+    # Print the version of stewbeet, beet, bolt, mecha, and stouputils
+    if second_arg in ("--version", "-v", "version"):
+        return show_version("stewbeet", primary_color=RED, secondary_color=GREEN)
+
+    # Try to find and load the beet configuration file
+    cfg: ProjectConfig = get_project_config()
+
+    # Check if the command is "clean" or "rebuild"
+    if second_arg in ["clean", "rebuild"]:
+        info("Cleaning project and caches...")
+
+        # Remove the beet cache directory
+        subprocess.run([sys.executable, "-m", "beet", "cache", "-c"], check=False, capture_output=True)
+        if os.path.exists(".beet_cache"):
+            shutil.rmtree(".beet_cache", ignore_errors=True)
+
+        # Remove the output directory specified in the config
+        shutil.rmtree(str(cfg.output), ignore_errors=True)
+
+        # Remove all __pycache__ folders
+        for root, dirs, _ in os.walk("."):
+            if "__pycache__" in dirs:
+                cache_dir: str = os.path.join(root, "__pycache__")
+                shutil.rmtree(cache_dir, ignore_errors=True)
+
+        # Remove manual cache directory if specified in metadata
+        cache_path: str = cfg.meta.get("stewbeet", {}).get("manual", {}).get("cache_path", "")
+        if cache_path and os.path.exists(cache_path):
+            shutil.rmtree(cache_path, ignore_errors=True)
+
+        # Remove debug definitions file if it exists
+        definitions_debug: str = cfg.meta.get("stewbeet", {}).get("definitions_debug", "")
+        if definitions_debug and os.path.exists(definitions_debug):
+            os.remove(definitions_debug)
+        info("Cleaning done!")
+
+        # Replace "rebuild" by "build" to continue the process
+        if second_arg == "rebuild":
+            sys.argv[1] = "build"
+
+    # Handle all other commands except "clean"
+    if second_arg != "clean":
+        # Add current directory to Python path
+        current_dir: str = os.getcwd()
+        if current_dir not in sys.path:
+            sys.path.insert(0, current_dir)
+
+        # Try to import all pipeline
+        for plugin in cfg.pipeline:
+            handle_error(importlib.import_module, error_log=LogLevels.ERROR_TRACEBACK)(plugin)
+
+        # Run beet with all remaining arguments
+        subprocess.run([sys.executable, "-m", "beet"] + [x for x in sys.argv[1:] if x != "rebuild"], check=False)
+
+
+if __name__ == "__main__":
+    main()
+

stewbeet-2.2.31/stewbeet/continuous_delivery/__init__.py

@@ -0,0 +1,8 @@
+
+# Imports
+from .cd_utils import *
+from .github import *
+from .modrinth import *
+from .pmc import *
+from .smithed import *
+

stewbeet-2.2.31/stewbeet/continuous_delivery/cd_utils.py

@@ -0,0 +1,50 @@
+
+# Imports
+import os
+
+from stouputils.continuous_delivery.cd_utils import load_credentials  # type: ignore # noqa: F401
+
+from ..core.constants import LATEST_MC_VERSION
+from ..utils import ProjectConfig, get_project_config
+
+
+# Function that replace the "~" by the user's home directory
+def replace_tilde(path: str) -> str:
+	return path.replace("~", os.path.expanduser("~"))
+
+# Supported versions
+def get_supported_versions(version: str | list[str] | None = None) -> list[str]:
+	""" Get the supported versions for a given version of Minecraft
+
+	Args:
+		version (str): Version of Minecraft
+	Returns:
+		list[str]: List of supported versions, ex: ["1.21.3", "1.21.2"]
+	"""
+	# If version is None, get it from the project config, otherwise use the default version
+	if version is None:
+		try:
+			config: ProjectConfig = get_project_config()
+			version = config.meta.get("mc_supports") or config.minecraft or LATEST_MC_VERSION
+		except AssertionError:
+			version = LATEST_MC_VERSION
+	if isinstance(version, list):
+		return [x for x in version if x != "infinite"]
+	version = str(version)
+
+	# Some versions are considered the same for compatibility purposes
+	sames: list[list[str]] = [
+		["1.21", "1.21", "1.21.1"],
+		["1.21.2", "1.21.3"],
+		["1.21.6", "1.21.7", "1.21.8"],
+		["1.21.9", "1.21.10"],
+	]
+
+	# Find the matching list of versions
+	for s in sames:
+		if version in s:
+			return s
+
+	# If no match, return the version itself in a list
+	return [version]
+

stewbeet-2.2.31/stewbeet/continuous_delivery/github.py

@@ -0,0 +1,3 @@
+
+from stouputils.continuous_delivery.github import *  # type: ignore
+