chore

start of recipe list
start of images
have pack.mcmeta version auto replace with tag name

.github/workflows/release-from-tag.yml

@@ -1,4 +1,4 @@
-name: Create Release Archive
+name: Create Release with Archive from Tag
 
 on:
   push:
@@ -13,6 +13,13 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
 
+      - name: Find and Replace Version Placeholders
+        uses: jacobtomlinson/gha-find-replace@v3
+        with:
+          find: "<<VERSION>>"
+          replace: "${{ github.ref_name }}"
+          regex: false
+
       - name: Create Archive
         run: zip -r LoopsRecipes.zip pack.mcmeta pack.png data/
 

README.md

@@ -1,14 +1,41 @@
+<!-- ICON -->
+
+# ![LoopsRecipes](images/icon/icon.png) LoopsRecipes
+
 # LoopsRecipes
 
 A collection of custom Minecraft crafting recipes
 
-Current recipes:
+## Crafting recipes
+
+Can be found in [RECIPES.md](RECIPES.md)
+
+## Installation
+
+1. Download the latest release from [here](https://github.com/Loopios7/LoopsRecipes/releases/latest)
+2. Place the downloaded file in your world's datapacks folder
+3. Run `/reload` or restart your world
+4. Enjoy!
+<!-- 5. (Optional) Run `/function loops:recipes` to get all recipes in your inventory
+6. (Optional) Run `/function loops:recipes/clear` to clear your inventory of all recipes -->
+
+## Uninstallation
+
+<!-- 1. Run `/function loops:recipes/clear` to clear your inventory of all recipes -->
+
+1. Remove the datapack from your world's datapacks folder
+2. Run `/reload` or restart your world
+
+## Suggestions
+
+If you have any suggestions, please open an issue [here](https://github.com/Loopios7/LoopsRecipes/issues/new/choose)
+
+## Changelog
+
+Can be found in [CHANGELOG.md](CHANGELOG.md)
+
+## TODO
 
-- Craftable saddles
-- Convert deepslate to cobbled deepslate
-- Convert stone to cobblestone
-- Unpack blocks of amethyst to amethyst shards
-- More nether bricks
-- More red nether bricks
-- Unpackable glowstone
-- Craft hoppers using barrels instead of chests
+- [ ] Add more recipes
+- [ ] Add functions to give all recipes
+- [ ] Add functions to clear inventory of all recipes

RECIPES.md

@@ -0,0 +1,52 @@
+# Crafting recipes
+
+## Crafting table
+
+### Craftables
+
+#### Craftable saddle
+
+<!-- TODO: Create image -->
+![Craftable saddle](images/crafting_table/craftables/saddle.png)
+
+#### Craftable hoppers using barrels
+
+<!-- TODO: Create image -->
+![Craftable hoppers using barrels](images/crafting_table/craftables/hopper.png)
+
+#### Craftable Smooth Stone
+
+<!-- TODO: Create image -->
+![Craftable Smooth Stone](images/crafting_table/craftables/smooth_stone.png)
+
+### Unpackables
+
+#### Amethyst block to amethyst shards
+
+![Amethyst block to amethyst shards](images/crafting_table/unpackables/amethyst_shard.png)
+
+#### Glowstone block to glowstone dust ![Glowstone block to glowstone dust](images/crafting_table/unpackables/glowstone_dust.png)
+
+### Converters
+
+#### Deepslate to cobbled deepslate
+
+<!-- TODO: Create image -->
+![Deepslate to cobbled deepslate](images/crafting_table/converters/cobbled_deepslate.png)
+
+#### Stone to cobblestone
+
+<!-- TODO: Create image -->
+![Stone to cobblestone](images/crafting_table/converters/cobblestone.png)
+
+### More Blocks
+
+#### More nether bricks
+
+<!-- TODO: Create image -->
+![More nether bricks](images/crafting_table/more_blocks/nether_bricks.png)
+
+#### More red nether bricks
+
+<!-- TODO: Create image -->
+![More red nether bricks](images/crafting_table/more_blocks/red_nether_bricks.png)

pack.mcmeta

@@ -1,6 +1,6 @@
 {
   "pack": {
     "pack_format": 10,
-    "description": "§aCustom Recipes v1.8\n§bBy @Loopios7"
+    "description": "§aCustom Recipes - <<VERSION>>\n§bBy @Loopios7"
   }
 }