diff --git a/docs/Features/Hotbar.md b/docs/Features/Hotbar.md new file mode 100644 index 0000000..ca559a7 --- /dev/null +++ b/docs/Features/Hotbar.md @@ -0,0 +1,60 @@ +# Hotbar +Epip offers a heavily improved Hotbar UI, featuring multiple bars, custom "action" buttons in the bottom left, additional skill panels shared between characters and numerous functions to make hotbar management easier. + +![Hotbar preview.](img/hotbar/showcase.png) + +## Multiple Rows + +To add/remove rows, click the small +/- icons to the right of the buttons area. You can cycle each row independently through all 5 rows of slots that the game allows. You can have up to 5 rows visible. + +![Hotbar 5 rows](img/hotbar/five_bars.png) + +You can use the regular hotkeys (F/R by default) to cycle the bottom bar. Holding shift while using them will cycle the second row from the bottom instead. Holding Ctrl will cycle the 3rd row, while holding alt will cycle the 4th one. + +## New Controls + +Right-click a row on the hotbar to bring up a context menu where you can "push" groups of slots around (great for inserting spells inbetween!), clear unmemorized spells, or save "loadouts" to restore your hotbars in later playthroughs. + +![Hotbar context menu.](img/hotbar/loadouts.png) + +## Skill Groups + +"Create group..." option shown in menu above allows you to create spell (or item) groups shared between characters. Very handy for keeping all the essential spells in one place. + +![Skill group showcase](img/hotbar/group.png) + +Slots with items assigned to them will collect items from all characters, simplifying management. + +Existing groups can be dragged around by their handle. Right-clicking a Skill Group will bring up a submenu with *Delete* and *Resize* options. + +## Action Bar + +The buttons next to the portrait are now customizable; when your hotbar is unlocked, you can drag and drop to rearrange them. Additionally, mods can add their own "actions" there, and there are a few new built-in ones. You can press the middle mouse button to unbind them. + +Right click one of those buttons or click the `^` button to bring up a "drawer" with all the actions that you can drag and drop onto your actions bar. You can also click them to use them directly from there. + +![Hotbar action drawer preview.](img/hotbar/drawer.png) + +**Action bar has to be unlocked to allow drag and drop! The lock button is located right under the +/- buttons!** + +By default, if you have 2+ rows of hotbar slots, you will also have a second row of these customizable buttons. +You can disable this in **Options -> Epip Settings -> Hotbar -> Hotbar Buttons Area Sizing**. + +These buttons can be used with keyboard hotkeys; to do so, you must assign keys to them in **Options -> Controls -> Epip Encounters -> Hotbar Action #N (top/bottom row)**. +You can toggle whether assigned hotkeys are displayed on the buttons in **Options -> Epip Settings -> Hotbar -> Show Action Hotkeys**. + +### New Actions + +Epip Encounters implements multiple handy new actions, in addition to all vanilla functions: + +- ![Hotbar action pyramids](img/hotbar/action_pyramids.png) - Pyramids: Uses the teleporter pyramid on current character. +- ![Hotbar action chain](img/hotbar/action_chain.png) - Chain/Unchain: Toggle chaining with your nearby party members. Instant, plays no animation. +- ![Hotbar action rest](img/hotbar/action_rest.png) - Bedroll Rest: Requires **any** of your party members to have a bedroll in inventory. +- ![Hotbar action vanity](img/hotbar/action_vanity.png) - Vanity: A Vanity menu shortcut. +- ![Hotbar action respec](img/hotbar/action_respec.png) - Respec: Requires **any** of your party members to have a Portable Respec Mirror provided by [this mod](https://steamcommunity.com/sharedfiles/filedetails/?id=1507233042) in inventory. +- ![Hotbar action meditate](img/hotbar/action_meditate.png) - Meditate +- ![Hotbar action SI](img/hotbar/action_si.png) - Source Infuse + +The purpose of the action bar is to provide a centralized place for modders to add shortcuts/hotkeys to their interfaces or features, eliminating the need for interactable books that clutter your inventory and freeing up space on the hotbar. + +[The hotbar improvements are also available as a standalone mod with no EE dependency.](https://steamcommunity.com/sharedfiles/filedetails/?id=2759281297) diff --git a/docs/Features/img/hotbar/action_chain.png b/docs/Features/img/hotbar/action_chain.png new file mode 100644 index 0000000..df87a76 Binary files /dev/null and b/docs/Features/img/hotbar/action_chain.png differ diff --git a/docs/Features/img/hotbar/action_meditate.png b/docs/Features/img/hotbar/action_meditate.png new file mode 100644 index 0000000..4d5dbf5 Binary files /dev/null and b/docs/Features/img/hotbar/action_meditate.png differ diff --git a/docs/Features/img/hotbar/action_pyramids.png b/docs/Features/img/hotbar/action_pyramids.png new file mode 100644 index 0000000..13f58fe Binary files /dev/null and b/docs/Features/img/hotbar/action_pyramids.png differ diff --git a/docs/Features/img/hotbar/action_respec.png b/docs/Features/img/hotbar/action_respec.png new file mode 100644 index 0000000..e0662ba Binary files /dev/null and b/docs/Features/img/hotbar/action_respec.png differ diff --git a/docs/Features/img/hotbar/action_rest.png b/docs/Features/img/hotbar/action_rest.png new file mode 100644 index 0000000..244ac33 Binary files /dev/null and b/docs/Features/img/hotbar/action_rest.png differ diff --git a/docs/Features/img/hotbar/action_si.png b/docs/Features/img/hotbar/action_si.png new file mode 100644 index 0000000..c0b7781 Binary files /dev/null and b/docs/Features/img/hotbar/action_si.png differ diff --git a/docs/Features/img/hotbar/action_vanity.png b/docs/Features/img/hotbar/action_vanity.png new file mode 100644 index 0000000..2654b01 Binary files /dev/null and b/docs/Features/img/hotbar/action_vanity.png differ diff --git a/docs/Features/img/hotbar/drawer.png b/docs/Features/img/hotbar/drawer.png new file mode 100644 index 0000000..7e8b3f7 Binary files /dev/null and b/docs/Features/img/hotbar/drawer.png differ diff --git a/docs/Features/img/hotbar/five_bars.png b/docs/Features/img/hotbar/five_bars.png new file mode 100644 index 0000000..1c6bced Binary files /dev/null and b/docs/Features/img/hotbar/five_bars.png differ diff --git a/docs/Features/img/hotbar/group.png b/docs/Features/img/hotbar/group.png new file mode 100644 index 0000000..eb01df1 Binary files /dev/null and b/docs/Features/img/hotbar/group.png differ diff --git a/docs/Features/img/hotbar/loadouts.png b/docs/Features/img/hotbar/loadouts.png new file mode 100644 index 0000000..66922d8 Binary files /dev/null and b/docs/Features/img/hotbar/loadouts.png differ diff --git a/docs/Features/img/hotbar/showcase.png b/docs/Features/img/hotbar/showcase.png new file mode 100644 index 0000000..69f65ee Binary files /dev/null and b/docs/Features/img/hotbar/showcase.png differ diff --git a/docs/img/hotbar/bindings_warning.png b/docs/img/hotbar/bindings_warning.png deleted file mode 100644 index 160b552..0000000 Binary files a/docs/img/hotbar/bindings_warning.png and /dev/null differ diff --git a/docs/img/hotbar/context_menu.png b/docs/img/hotbar/context_menu.png deleted file mode 100644 index a85227b..0000000 Binary files a/docs/img/hotbar/context_menu.png and /dev/null differ diff --git a/docs/img/hotbar/five_bars.png b/docs/img/hotbar/five_bars.png deleted file mode 100644 index 7e8c52d..0000000 Binary files a/docs/img/hotbar/five_bars.png and /dev/null differ diff --git a/docs/img/hotbar/hotkeys.png b/docs/img/hotbar/hotkeys.png deleted file mode 100644 index 3483268..0000000 Binary files a/docs/img/hotbar/hotkeys.png and /dev/null differ diff --git a/docs/img/showcase/hotbar.PNG b/docs/img/showcase/hotbar.PNG deleted file mode 100644 index 82f0a5b..0000000 Binary files a/docs/img/showcase/hotbar.PNG and /dev/null differ diff --git a/docs/img/showcase/hotbar_drawer.PNG b/docs/img/showcase/hotbar_drawer.PNG deleted file mode 100644 index 5c46641..0000000 Binary files a/docs/img/showcase/hotbar_drawer.PNG and /dev/null differ diff --git a/docs/index.md b/docs/index.md index f49cc85..eb9a95b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -51,41 +51,12 @@ Player portraits display has also received some love, most notably - the list of Epip makes dozens of other UI changes to improve your experience. You can read about the rest of them [here](Features/UI.md). ### Hotbar -Epip offers a heavily improved Hotbar UI, featuring multiple bars, custom "action" buttons in the bottom left, and numerous functions to make hotbar management easier. +Epip offers a heavily improved Hotbar UI, featuring multiple bars, custom "action" buttons in the bottom left, additional skill panels shared between characters and numerous functions to make hotbar management easier. +Read all about it [here](Features/Hotbar.md). -![Hotbar preview.](img/showcase/hotbar.png) +![Hotbar preview.](Features/img/hotbar/showcase.png) -To add/remove rows, click the small +/- icons to the right of the buttons area. You can cycle each row independently through all 5 rows of slots that the game allows. You can have up to 5 rows visible. - -You can use the regular hotkeys (F/R by default) to cycle the bottom bar. Holding shift while using them will cycle the second row from the bottom instead. Holding Ctrl will cycle the 3rd row, while holding alt will cycle the 4th one. - -The buttons next to the portrait are now customizable; when your hotbar is unlocked, you can drag and drop to rearrange them. Additionally, mods can add their own "actions" there, and there are a few new built-in ones. You can press the middle mouse button to unbind them. - -Right click one of those buttons or click the `^` button to bring up a "drawer" with all the actions that you can drag and drop onto your actions bar. You can also click them to use them directly from there. - -![Hotbar action drawer preview.](img/showcase/hotbar_drawer.png) - -These buttons can be used with keyboard hotkeys; to do so, you must assign keys to them from Epip's input options menu. They are labelled "Hotbar Action #N" there. - -By default, if you have 2+ rows of hotbar slots, you will also have a second row of these customizable buttons. You can disable this from the settings menu. - -Epip Encounters implements multiple handy new actions, in addition to some vanilla functions: - -- Source Infuse & Meditate -- Toggle Minimap -- Resting (using a bedroll from anywhere in your party inventory - no need to find one for everyone!) -- Toggle Party Link (instantaneous, no animation!) -- Respec (if Portable Respec Mirror mod is installed) - -The purpose of the action bar is to provide a centralized place for modders to add shortcuts/hotkeys to their interfaces or features, eliminating the need for interactable books that clutter your inventory and freeing up space on the hotbar. - -Right-click a row on the hotbar to bring up a context menu where you can "push" groups of slots around (great for inserting spells inbetween!), clear unmemorized spells, or save "loadouts" to restore your hotbars in later playthroughs. - -![Hotbar context menu.](img/showcase/hotbar_context_menu.png) - -Additionally, all "engine actions" (except for flee) are available from the vanilla actions drawer. - -[The hotbar improvements are also available as a standalone mod with no EE dependency.](https://steamcommunity.com/sharedfiles/filedetails/?id=2759281297) +[Hotbar improvements are also available as a standalone mod with no EE dependency.](https://steamcommunity.com/sharedfiles/filedetails/?id=2759281297) ### Settings Menu The settings menu has been expanded to allow mods to add their own settings. Epip includes its own tab full of options to customize its features. diff --git a/mkdocs.yml b/mkdocs.yml index 1eecbbd..9e73228 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -23,6 +23,7 @@ nav: - FAQ: Info/faq.md - Features: - "UI improvements": "Features/UI.md" + - "Hotbar": "Features/Hotbar.md" - "Vanity": "Features/Vanity.md" - Documentation: - "Introduction": "docs.md"