From 187f26f0f42804b996499dd217c58929bd404f3a Mon Sep 17 00:00:00 2001 From: KaenbyouA <95231551+RedMisao@users.noreply.github.com> Date: Fri, 6 Dec 2024 21:54:04 -0500 Subject: [PATCH] Update HELP_MENU.md --- doc/HELP_MENU.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/HELP_MENU.md b/doc/HELP_MENU.md index 393dc45f777bf..bcc4a51d09dcf 100644 --- a/doc/HELP_MENU.md +++ b/doc/HELP_MENU.md @@ -10,19 +10,19 @@ Each category is made up of a json object which for mods can be placed anywhere | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `"type"` | (required) must be `"help"` | | `"order"` | (required) integer, where this category should appear in the list relative to others from the same source, with 0 being first. Must be unique per source (Every mod can start from 0). Each mods categories are appended to the end of the list per their load order. | -| `"name"` | (required) string, name of the category, can use [color tags](COLOR.md#Color tags) | -| `"messages"` | (required) array of strings, each string respresents a new line seperated paragraph containing information for this category, can use [color tags](COLOR.md#Color tags) and [keybind tags](#Keybind tags). Seperated mainly for ease of editing the json as `\n` lets you add newlines within strings | +| `"name"` | (required) string, name of the category, can use [color tags](COLOR.md#color-tags) | +| `"messages"` | (required) array of strings, each string respresents a new line seperated paragraph containing information for this category, can use [color tags](COLOR.md#color-tags) and [keybind tags](#keybind-tags). Seperated mainly for ease of editing the json as `\n` lets you add newlines within strings | ### Keybind tags The keybind tags here use a different syntax than elsewhere for now. -Keybind tags take the form where keybind corresponds to a keybind id, most of which are found in [keybindings.json](./data/raw/keybindings.json) and are automatically colored light blue. +Keybind tags take the form where keybind corresponds to a keybind id, most of which are found in [keybindings.json](/data/raw/keybindings.json) and are automatically colored light blue. ### Special tags -`` and `` are special hardcoded tags that can be found in [help.cpp](./src/help.cpp) +`` and `` are special hardcoded tags that can be found in [help.cpp](/src/help.cpp). `` displays a list of all the color abbreviations to be used with overmap notes. -`` displays the hjkl and numpad movement directions in a nicely rendered way. The movement directions have 3 binds by default with the above keybind tags not letting you specify which to use so unhardcoding it would result in a messier drawing. +`` displays the hjkl and numpad movement directions in a nicely rendered way. The movement directions have 3 binds by default with the above keybind tags not letting you specify which to use so unhardcoding it would result in a messier drawing. ### Example @@ -34,3 +34,7 @@ Keybind tags take the form where keybind corresponds to a keybin "messages": [ "A useful tip.", "Some scary warning.", "A list of three keybinds.\n lets you pass one second.\n lets you wait for longer.\n lets you sleep." ] }, ``` +Which will be displayed as: + +![help example](https://github.com/user-attachments/assets/e6d620a0-0123-4beb-afcc-3e68f73597ca) +