Skip to content

Commit

Permalink
Update pack to 1.20.2 + update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
osfanbuff63 committed Jan 6, 2024
1 parent 8840e96 commit 9f9368d
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ updates:
prefix: "chore: "
include: "scope"
reviewers:
- "osfanbuff63" # change to your username so you don't request me :P
- "osfanbuff63" # IMPORTANT: change to your username so you don't request me :P
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
uses: mcbeet/check-commands@v1
with:
source: .
minecraft: 1.19
minecraft: 1.20
# Checks JSON for errors
- name: Check JSON
uses: ocular-d/[email protected]
Expand Down
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

## What is this?

A template for a Minecraft datapack on GitHub! This is meant for new players to the datapack community, who don't know much about how datapacks work, or the dos and don'ts of datapacks. Check out the data folder to learn more!
A template for a Minecraft datapack on GitHub! This is meant for new players to the datapack community, who don't know much about how datapacks work, or the dos and don'ts of datapacks. Check out the data folder to learn more! This is currently for Minecraft 1.20.3/1.20.4, but there's [details on how to downgrade from this template below](#downgrading-the-pack).

It's worth noting that this is *not* the vanilla datapack of Minecraft (as publishing that would violate the Minecraft EULA), but rather a template for a custom one.

This also includes:

- A GitHub Actions CI workflow for Minecraft datapacks
- A .gitignore file (you may need to adapt this to your needs, this gitignore includes VSCode (my primary IDE), Git (yes, I know, it's not counter-intuitive), Windows, and Notepad++ (my secondary IDE))
- A .gitignore file (you may need to adapt this to your needs, this gitignore includes [VS Code](https://code.visualstudio.com), [Git](https://git-scm.com/) spare files, Windows, and [Notepad++](https://notepad-plus-plus.org/))

## License

Licensed under the [CC0-1.0 license](LICENSE.md). Feel free to do anything you want, pretty much :D.

## Credit

Thanks to @M3FF1N for the `pack.png`!
Thanks to [**@M3FF1N**](https://github.com/M3FF1N) for the `pack.png`!

## Information on files in the root directory

Expand All @@ -41,15 +41,19 @@ The `pack_format` key is what tells Minecraft what version of Minecraft your pac
| 1.18.2 | 9 |
| 1.19 - 1.19.3 | 10 |
| 1.19.4 | 12 |
| 1.20.0+ | 15 |
| 1.20 - 1.20.1 | 15 |
| 1.20.2 | 18 |
| 1.20.3 - 1.20.4 | 26 |

You can also check these on the [Minecraft Wiki](https://minecraft.wiki/w/Pack_format#List_of_data_pack_formats), where there is more information about what changed between versions.

Sample `pack.mcmeta` (you can also see in the example datapack [here](pack.mcmeta)):

```json

{
"pack": {
"pack_format": 9,
"pack_format": 26,
"description": "§6§kM§r §6Made by §3osfanbuff63 §6§kK§r - v1.0.0"
}
}
Expand All @@ -61,3 +65,20 @@ The description key ideally describes your datapack, or its version, or somethin
#### pack.png

The `pack.png` file is the image that will appear when the menu for datapacks is opened, representing your datapack. It is not required. It can be any image file, but it must be of the `.png` file type, otherwise Minecraft will not recognize it. Many image editors, such as [GIMP](https://gimp.org), include functionality to convert image files by saving them in a different format. If your ideal image is a `.jpg` or `.jpeg` file and you don't have a photo editor installed, you can use a tool like [this one](https://jpg2png.com/) to convert them.

## Downgrading the pack

This template is intended for Minecraft 1.20.3/1.20.4, but you may not want to use that version. Changing the template to use an older version is pretty simple, but be sure you don't use a feature from newer versions. The [Minecraft Wiki](https://minecraft.wiki/w/Pack_format#List_of_data_pack_formats) has a page with all the `pack_format` versions and the changes in those versions.

For example, if you wanted to change to Minecraft 1.20.2, you would change the `pack_format` key to match that:

```json

{
"pack": {
"pack_format": 18,
"description": "§6§kM§r §6Made by §3osfanbuff63 §6§kK§r - v1.0.0"
}
}

```
2 changes: 1 addition & 1 deletion data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Datapacks are split up into **namespaces**. In this example, we use the `minecraft` namespace, and our own namespace, in this case `example_datapack`. Use the `minecraft` namespace to override vanilla, and your own to add new features.

> **Warning**: **Do NOT include Minecraft's vanilla datapack in a custom datapack! This is a violation of the Minecraft EULA!**
> [!WARNING]: **Do NOT include Minecraft's vanilla datapack in a custom datapack! This is a violation of the Minecraft EULA!**
2 changes: 1 addition & 1 deletion data/example_datapack/advancements/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Advancements

Advancements are given by a trigger inside of Minecraft, or the `/advancement` command. The example in this tab uses the `minecraft:impossible` trigger, this is due to automatically triggering if a player doesn't already have it (see tick.mcfunction). There are many triggers available. As a result, I recommend, especially if you are new, using [misode.github.io](https://misode.github.io) for some amazing generators.
Advancements are given by a trigger inside of Minecraft, or the `/advancement` command. The example in this tab uses the `minecraft:impossible` trigger, this is due to automatically triggering if a player doesn't already have it (see tick.mcfunction). There are many triggers available. As a result I recommend, especially if you are new, using [misode.github.io](https://misode.github.io) for some amazing generators.
2 changes: 1 addition & 1 deletion data/example_datapack/loot_tables/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

Loot tables allow you to change the loot of Minecraft, or add new loot tables. This folder will create a new loot table that could be used in a `/summon` or `/setblock` command. Check out the `minecraft` namespace if you want to override a vanilla loot table - as this will use a different method.

Personally, especially if you are new or don't understand JSON or how Minecraft uses it (if this makes no sense to you, just keep reading), [using Misode's generators](https://misode.github.io). I have used that for this tutorial (although I could do it on my own probably :P).
Personally, especially if you are new or don't understand JSON or how Minecraft uses it (if this makes no sense to you, just keep reading), [use Misode's generators](https://misode.github.io). I have used that for this tutorial.
2 changes: 1 addition & 1 deletion pack.mcmeta
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"pack": {
"pack_format": 10,
"pack_format": 26,
"description": "§6§kM§r §6Made by §3osfanbuff63 §6§kK§r - v1.0.0"
}
}
Expand Down

0 comments on commit 9f9368d

Please sign in to comment.