Files
NoN-Site/Guide.md
T

2.7 KiB
Raw Blame History

Site Guide

A quick guide for creators keeping their packs and models compatible with the site.

1. Pick the right category

Every project belongs to one of: NoN Pack, Model, Skin, Mod, Modpack, or Guide. The site auto-detects compatibility from what you upload, so choosing the right category is the most important step.

2. NoN Packs

  • Include a pack.mcmeta with an animationframework block:
    {
      "pack": { "pack_format": 64, "description": "..." },
      "animationframework": { "id": "yournamespace:yourpack" }
    }
    
  • Pack content goes under assets/<namespace>/ and data/<namespace>/afw_animdefs/, using the afw_* model keys.
  • The id is what the in-game auto-updater queries (/api/packs/<namespace>/<pack_id>/latest), so make it stable.

3. Models

  • Build in Blockbench with GeckoLib 5+.
  • Upload .bbmodel, .geo.json, or .jem — these render in the viewer.
  • .gltf / .glb are recognized but cannot be previewed (the import is desktop-only).
  • Species auto-tagging only recognizes vanilla mobs.

4. Plugins

If a Model upload contains a plugins/ folder with .js plugin files, the Models tab gains a Plugins tab that can hotload them. A plugins/autoload.txt lists the plugins loaded automatically.

5. Skins

  • Use 64×32, 64×64, or 128×128 PNGs.
  • Pick Steve (wide) or Alex (slim) when rendering.

6. Mods

  • Upload the .jar file(s), or a zip with the jars at its root — subfolders are ignored.
  • Loader (fabric, quilt, neoforge, forge) and the Minecraft version are auto-detected from the mod metadata.

7. Modpacks

  • Upload a .zip (CurseForge/Modrinth folder or instance export) or a .mrpack.
  • Loader and Minecraft version are inferred from the embedded mods.

8. Guides

  • Upload .md files, or a zip containing .md files plus their images.
  • Image and file links are auto-rewritten to the served files, so relative paths just work.
  • Tip: the site's textareas are plain inputs — write your guide in a Markdown editor (e.g. any Markdown editor with live preview, or GitHub's editor) and copy all the text with syntax onto the site.

9. Tags

  • Tags use e621 style: category:tag (e.g. loader:fabric, species:dragon).
  • The site auto-tags loader, version, format, and species — you can add manual tags too.

10. Upload flow

My Projects → New Project (the draft autosaves as you type) → add the version file(s), a thumbnail, and gallery media. Each file is classified by its extension.

11. Compatibility checklist

  • Zip multi-file uploads before uploading.
  • Include the Minecraft version in mod metadata.
  • Use clear, stable filenames and pack ids.