Skip to content

Commit

Permalink
feat(docs): Update resources section
Browse files Browse the repository at this point in the history
  • Loading branch information
ChampionAsh5357 committed Dec 16, 2024
1 parent a973c39 commit 8746736
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/resources/client/items/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Client Items

TODO (Add for correct linkage, update later)
22 changes: 20 additions & 2 deletions docs/resources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,23 @@ Assets, or client-side resources, are all resources that are only relevant on th

NeoForge automatically collects all mod resource packs into the `Mod resources` pack, which sits at the bottom of the Selected Packs side in the resource packs menu. It is currently not possible to disable the `Mod resources` pack. However, resource packs that sit above the `Mod resources` pack override resources defined in a resource pack below them. This mechanic allows resource pack makers to override your mod's resources, and also allows mod developers to override Minecraft resources if needed.

Resource packs can contain [models][models], [blockstate files][bsfile], [textures][textures], [sounds][sounds], [particle definitions][particles] and [translation files][translations].
Resource packs may contain folders with files affecting the following things:

| Folder Name | Contents |
|---------------|-----------------------------------------|
| `atlases` | Texture Atlas Sources |
| `blockstates` | [Blockstate Files][bsfile] |
| `equipment` | [Equipment Info][equipment] |
| `font` | Font Definitions |
| `items` | [Client Items][citems] |
| `lang` | [Translation Files][translations] |
| `models` | [Models][models] |
| `particles` | [Particle Definitions][particles] |
| `post_effect` | Post Processing Screen Effects |
| `shaders` | Metadata, Fragement, and Vertex Shaders |
| `sounds` | [Sound Files][sounds] |
| `texts` | Miscellaneous Text files |
| `textures` | [Textures][textures] |

## Data

Expand All @@ -32,7 +48,7 @@ There is currently no built-in way to apply a set of custom data packs to every

Data packs may contain folders with files affecting the following things:

| Folder name | Contents |
| Folder Name | Contents |
|-----------------------------------------------------------------------------------|------------------------------|
| `advancement` | [Advancements][advancements] |
| `damage_type` | [Damage types][damagetypes] |
Expand Down Expand Up @@ -179,12 +195,14 @@ runs {
[blockstateprovider]: client/models/datagen.md#block-model-datagen
[bsfile]: client/models/index.md#blockstate-files
[chattype]: https://minecraft.wiki/w/Chat_type
[citems]: client/items/index.md
[codec]: ../datastorage/codecs.md
[damagetypes]: server/damagetypes.md
[datamap]: server/datamaps/index.md
[datamapprovider]: server/datamaps/index.md#data-generation
[datapackcmd]: https://minecraft.wiki/w/Commands/datapack
[datapackprovider]: ../concepts/registries.md#data-generation-for-datapack-registries
[equipment]: ../items/armor.md#equipment-models
[event]: ../concepts/events.md
[eventhandler]: ../concepts/events.md#registering-an-event-handler
[function]: https://minecraft.wiki/w/Function_(Java_Edition)
Expand Down

1 comment on commit 8746736

@neoforged-pages-deployments
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploying with Cloudflare Pages

Name Result
Last commit: 8746736544508370ad9c55433efb35bc7cfb7aa1
Status: ✅ Deploy successful!
Preview URL: https://ec704006.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-211.neoforged-docs-previews.pages.dev

Please sign in to comment.