Halo

## Warning Version 1.1.1 of the mod includes a **breaking change**!!! Loading an old save after updating will cause all entity halo NBT data to be lost, and this data **can NOT be recovered**!!! Please back up your data and proceed with caution before updating! ## Description > Inspired by the iconic halos from **Blue Archive**. > Some of the **BA** halos displayed in the gallery must be obtained [here](https://github.com/AzusaKe/Ba-Halo-Definition). Halo adds configurable floating halos above entity heads. Each halo is defined by a JSON file and can stack multiple textured layers with independent position, rotation, scale, and glowing settings. A flexible animation system drives per-layer motion via sine, cosine, and linear terms on any axis, from subtle idle bobbing to staggered clock-ring rotation. ## YSM Compatible YSM compatibility is currently undergoing testing; you may encounter graphical glitches. This feature is disabled by default. To enable it, navigate to the game instance's root directory, locate `./config/halo-azusake/halo_mod_config.json`, open it in a text editor, and set the `experimentalYsmAnchorEnabled` field to `true`. A restart is required for the changes to take effect. If the halo appears positioned too high or too low, adjust the `experimentalYsmHeadLocalOffset` field in the same file. The three parameters correspond to `[x, y, z]`, representing displacement to the right, upward, and backward, respectively. ## Usage - Use `/halo show ` to show halo above target entity - Use `/halo hide ` to hide its halo - Use `/halo list` to list halo loaded - Other command are used for debug ## How to add Halo Check Doc in [English](https://github.com/AzusaKe/Halo/blob/main/docs/en/quickstart.md) or [Chinese](https://github.com/AzusaKe/Halo/blob/main/docs/zh/quickstart.md) Or Download resource pack from [Ba-Halo-Definition](https://github.com/AzusaKe/Ba-Halo-Definition) ### Features - **Multi-layer halos** — stack multiple layers with per-layer transform and glowing toggle - **Per-layer animation** — sin, cos, and linear function terms on any offset or rotation axis; multiple terms on the same axis are summed - **Orientation modes** — locked (follows entity yaw), free (floats loose), sync (hybrid) - **Data-driven** — all definitions are JSON files under `data/halo/halo_definitions/`; compatible with data packs and resource packs - **Ingame commands** — `/halo` for real-time preview and management ### Built-in definitions - `ring_default` — a 7-layer clock-ring design - `hud` — a hud like design ### Compatibility - Minecraft 1.19.4 ~ 1.20.4 , 1.21.1 , 26.1.x , 26.2 - Fabric Loader 0.15+ - Requires Fabric API > **1.19.4 Note**: Core features (show/hide, multiplayer sync, persistence) work, but `/halo list`, `/halo active`, and `/halo dump` produce no chat output. Other versions are unaffected. #### NeoForge / Forge This mod is natively built for Fabric, but can also run on **NeoForge / Forge 1.20.1** via [Sinytra Connector](https://modrinth.com/mod/connector) + [Forgified Fabric API](https://modrinth.com/mod/forgified-fabric-api). Shader packs are compatible. 1. Install NeoForge or Forge for Minecraft 1.20.1 2. Install [Sinytra Connector](https://modrinth.com/mod/connector) 3. Install [Forgified Fabric API](https://modrinth.com/mod/forgified-fabric-api) 4. Place the Halo mod JAR into the `mods` folder