Image Format

• 32x32 pixels
• png format

File Structure

└── minecraft-cursor/
    ├── atlases/
    │   └── cursors.json
    └── textures/
        └── cursors/
            ├── busy.png
            ├── default.png
            ├── grabbing.png
            ├── pointer.png
            ├── shift.png
            └── text.png

Custom Configuration

• Define a custom configuration for your resource pack in atlases/cursors.json.
• Can be overridden by users through the Cursor Settings menu.
• The user's config will reset to the provided config when changing resource packs.

Example cursors.json:

{
  "settings": {
    "default": {
      "xhot": 7,
      "yhot": 3,
      "scale": 0.8
    },
    "pointer": {
      "xhot": 7,
      "yhot": 3,
      "scale": 0.8
    },
    "text": {
      "xhot": 12,
      "yhot": 15,
      "scale": 0.8
    },
    "grabbing": {
      "enabled": false 
    },
    "shift": {
      "xhot": 11,
      "yhot": 3
    }
  }
}

All Settings:

Animated Cursors

• Create a sprite sheet in PNG format for the cursor type. The sprites will be evaluated from top to bottom.
• Each sprite must be 32x32 pixels as per usual with no gaps in between.
• The first sprite serves as the fallback cursor type when the animation is disabled by the user, or if the animation data does not load.
• Add a .mcmeta file for the cursor type to register the animation and to specify the animation data.

Example structure:

└── minecraft-cursor/
    └── textures/
        └── cursors/
            ├── busy.png
            └── busy.png.mcmeta

The .mcmeta file is in JSON format:

Example .mcmeta file:

{
  "mode": "loop",
  "frametime": 1,
  "frames": [{ "index": 0, "time": 2 }, 1, 2, 3, 2]
}    

Widgets are automatically registered by this mod with the following conditions: 

• Pointer elements must be an instance of PressableWidget or SliderWidget
• ClickableWidget is not registered as they are not always a button. For example: ScrollableWidget is a subclass of ClickableWidget
• Text elements must be an instance of TextFieldWidget
• They must be a child of ParentElement (e.g. Screen), accessible through children() method
• Container elements must be an instance of ParentElement and nested containers must be an instance and child of ParentElement

GUI "elements" that may be affected from shifting their positions and sizes:

• CreativeInventoryScreen tabs
• EnchantmentScreen choices
• StonecutterScreen recipes
• BookEditScreen book
• LoomScreen patterns
• AdvancementsScreen tabs
• WorldListWidget world icon play button
• MultiplayerServerListWidget server icon play button