Skip to main content

FreeMinecraftModels Setup

FreeMinecraftModels still supports manual .bbmodel imports, but the current setup flow is Nightbreak-aware and menu-driven.

Prerequisites​

  • A Java 21 runtime for the server
  • FreeMinecraftModels installed and started once so it can generate its data folders
  • A way to deliver the generated resource pack to players

ResourcePackManager is the recommended delivery path because FreeMinecraftModels only generates the pack; it does not host it by itself.

First-Time Flow​

CommandPurpose
/fmm setupPlayer-only content-management / first-time onboarding menu (the command players are pointed at on first boot)
/fmm recommendedpluginsBrowse companion plugins that pair well with FreeMinecraftModels
/fmm downloadallBulk install helper: downloads the latest plugin update plus all accessible Nightbreak packs
/fmm downloadallcontentBulk install helper for accessible Nightbreak packs (content only)
/fmm updatecontentBulk update helper for outdated Nightbreak packs
/fmm downloadpluginupdateDownloads the latest plugin jar update only
/nightbreaklogin <token>Shared Nightbreak token registration

If config.yml still has setupDone: false, players with freeminecraftmodels.* get a one-time login reminder pointing them at /fmm setup (opening it permanently dismisses the message). The reminder also surfaces /fmm admin and /fmm.

  1. Install FreeMinecraftModels and start the server once.
  2. Link a Nightbreak token with /nightbreaklogin <token>.
  3. Open /fmm setup to inspect available packs and current state.
  4. Use /fmm downloadall if you want to install every official pack your token can access (this also pulls the latest plugin jar update).
  5. Use /fmm updatecontent later to refresh outdated official packs.
  6. Make sure players receive the generated output/FreeMinecraftModels.zip pack, usually through ResourcePackManager.

If you would rather have the server fetch updates on its own, set nightbreak.autoDownloadPluginUpdates: true in config.yml (default false). Downloaded plugin and content updates are applied after the next restart. See Configuration.

Manual Model Imports​

Direct model import still works through:

plugins/FreeMinecraftModels/imports

That path is still useful for:

  • local development
  • custom models you are not pulling from Nightbreak
  • converting .bbmodel content into the current runtime format when you run /fmm reload

Manual imports and official package downloads both end up depending on a reload/import pass before the runtime model list and resource pack are rebuilt.

Official Content Packs​

The current plugin ships with five premade Nightbreak-managed packages:

  • Basic Furniture Pack (props)
  • BetterStructures Prop Pack (props)
  • EliteMobs Prop Pack (props)
  • Craftenmine's Weapons Item Pack (custom items)
  • Craftenmine Tools Item Pack (custom items)

These appear inside /fmm setup, can be bulk-downloaded with /fmm downloadall, and can be updated with /fmm updatecontent. The two Craftenmine item packs are custom items (models with material: set) and are eligible for Lua item scripts.

Resource Pack Reminder​

FreeMinecraftModels always needs its generated resource-pack output to reach the client one way or another.

See Resource pack output for the current output paths and ResourcePackManager integration.