HQ

(Fabric)

One button for everything: HQ adds an "HQ" button to your inventory that opens a
list of shortcuts to your mods' settings screens and to any command you save. Currently this only works with catastrophic_impact's mods to add a convenient GUI button to access all mod settings in one place. See below if you want your mod settings to work with it as well.

----------------------------------------------------------------
FEATURES
----------------------------------------------------------------
The HQ button
- Survival inventory: just above the top-left corner of the inventory. It moves
  with the inventory when the recipe book opens.
- Creative inventory: just left of the top-left corner (the creative tabs are
  above).
- Kept away from the right side, where item-list mods like JEI, REI and EMI
  and inventory sort buttons usually go.

The shortcut list
- One button per shortcut. Press it and the command runs as if you typed it.
- Mod shortcuts come first, then your own. Hover over a button to see its
  command and who added it.
- Your own shortcuts have an X button to delete them.
- Add new shortcuts right in the list: type a name and a command, then press
  Add.
- Long lists are split into pages.

Shortcuts from mods
- Mods that support HQ add their own shortcut automatically. Nothing to set up.
- If you remove a mod, its shortcut is gone the next time you start the game.
  Nothing is left behind in your config.
- Mod shortcuts can't be deleted (they belong to the mod).

Your own shortcuts
- Save any command, for example:
  /hq add findvillage /locate structure minecraft:village_plains
- Then run it with /hq findvillage or from the HQ list.
- Commands run with your own permissions: HQ never lets you use a command you
  couldn't type yourself.

----------------------------------------------------------------
COMMANDS
----------------------------------------------------------------
/hq                       Open the HQ list.
/hq add <name> <command>  Save a command as a shortcut. The leading / is
                          optional.
/hq <name>                Run a shortcut.
/hq remove <name>         Delete one of your shortcuts.
/hq list                  List every shortcut in chat.

Names can use letters, numbers, _ and - (up to 32). "add", "remove" and "list"
are reserved.

----------------------------------------------------------------
SETTINGS
----------------------------------------------------------------
Your shortcuts are saved in config/hq.json. Everything is managed from the HQ
list or the /hq commands.

----------------------------------------------------------------
HQ COMPATIBILITY (for mod authors)
----------------------------------------------------------------
Add your mod's shortcut with no code and no dependency on HQ. Put this in your
mod's fabric.mod.json:

  "custom": {
    "hq": { "name": "My Mod", "command": "mymod" }
  }

- "command": what to run, without the slash.
- "name": the button label (default: your mod's name).
- "id": optional, the name for /hq <id> (default: your mod id).
- For several shortcuts, use a list of these objects.

HQ reads these from the installed mods every time the game starts.

Mods with HQ shortcuts: More Danger, Populations, Tameful, Conflict Resolution,
Any Skins.

----------------------------------------------------------------
COMPATIBILITY & NOTES
----------------------------------------------------------------
- Client only: it doesn't need to be on the server.
- Works with mods that open their screens through a client command (like /md)
  as well as with server commands.

----------------------------------------------------------------
CHANGELOG
----------------------------------------------------------------
1.0.0
- First release.