Skip to content

A client-side Minecraft mod for Fabric & NeoForge that automatically reloads resources on game startup or when joining a world.

License

Notifications You must be signed in to change notification settings

cppbear/auto_resource_reloader

Repository files navigation

Auto Resource Reloader

中文 README

Auto Resource Reloader is a lightweight client-side Minecraft mod that automatically refreshes resource packs when the game starts or when you enter a world. It removes the need to manually reopen resource packs after each launch or world switch, keeping custom assets and textures in sync without hassle.

Features

  • Automatic resource reload the first time the main menu opens in a session.
  • Optional resource reload the first time you join any world in the current play session.
  • Simple JSON configuration stored alongside other Minecraft config files.
  • Shared codebase delivered for both Fabric and NeoForge via Architectury.

Compatibility

  • Minecraft: 1.21.1
  • Java: 21 (JDK 21 or newer release-compatible runtime)
  • Fabric Loader: 0.17.3+ (for Fabric builds)
  • Fabric API: 0.116.7+ (recommended for Fabric builds)
  • NeoForge: 21.1.209+ (for NeoForge builds)
  • Architectury API: 13.0.8+

Installation

Fabric

  1. Install Fabric Loader 0.17.3 or newer for Minecraft 1.21.1.
  2. Install Fabric API 0.116.7 or newer.
  3. Download the Fabric release jar from the mod's distribution (e.g., GitHub Releases or Modrinth).
  4. Place the jar in the mods folder of your Minecraft instance.

NeoForge

  1. Install NeoForge 21.1.209 or newer for Minecraft 1.21.1.
  2. Download the NeoForge release jar.
  3. Place the jar in the mods folder of your Minecraft instance.

The mod is client-side only. It does not need to be installed on dedicated servers.

Configuration

The configuration file is generated at config/auto_resource_reloader.json after the mod runs once. The default values are:

Key Default Description
reloadOnStartup true Reload resource packs when the main menu opens in a fresh game session.
reloadOnWorldJoin false Reload resource packs the first time you join a world during the current session.
comment (string) Helper text explaining the configuration fields.

Toggle the boolean flags to tailor when automatic reloads are triggered. The file is written using pretty-printed JSON for easy editing.

Building from Source

  1. Install JDK 21.
  2. Clone this repository.
  3. Run ./gradlew :common:build to compile the shared module.
  4. Run ./gradlew :fabric:build for the Fabric jar or ./gradlew :neoforge:build for the NeoForge jar. The resulting artifacts live under each module's build/libs directory.

Gradle will download all required dependencies (Architectury, Fabric API, NeoForge, etc.) on the first run.

Contributing

Issues and pull requests are welcome. Please describe observed behaviour, expected outcomes, and steps to reproduce when reporting bugs.

License

This project is licensed under the MIT License.

About

A client-side Minecraft mod for Fabric & NeoForge that automatically reloads resources on game startup or when joining a world.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages