Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions docs/Features/Hotbar.md
Original file line number Diff line number Diff line change
@@ -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)

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This screenshot is pretty bad. Hotbar groups cover up the action buttons on the left and overlap with the regular hotbar on the right. Please use a different screenshot where hotbar groups are not overlaying the regular hotbar. You can crop out part of the hotbar horizontally, it's not necessary to show all 27 slots of each row.
five_bars.png does it well.


## 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.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hidden epip knowledge: holding the GUI key will cycle the fifth row
(No need to disclose that, it's just a fyi)


## 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.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would reword "spell (or item) groups" to just "hotbar slot groups"

"the essential spells" here sounds a bit weird, since "essential spells" are not the same for everyone. Would reword to something like "Very handy for keeping spells you use across multiple characters in one place."


![Skill group showcase](img/hotbar/group.png)

Slots with items assigned to them will collect items from all characters, simplifying management.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would reword this to: "Assigning an item to these slots will use all stacks of it from across the party inventory."


Existing groups can be dragged around by their handle. Right-clicking a Skill Group will bring up a submenu with *Delete* and *Resize* options.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should mention that delete/resize is not yet canon and requires "Cathe's Arse.pak" mod

Just kidding


## 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)

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot should be taken with the hotkey bindings enabled.


**Action bar has to be unlocked to allow drag and drop! The lock button is located right under the +/- buttons!**

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exclamation mark at the end here is unnecessary.


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.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "-" looks pretty bad:
image

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confusing wording, it uses the TP pyramids from anywhere in the party inventory

- ![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.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would reword to "Uses a bedroll from the party inventory."
The bullet points should explain what the buttons do, even if to you it seems obvious. In this case the requirement (using my wording) is implicit.

- ![Hotbar action vanity](img/hotbar/action_vanity.png) - Vanity: A Vanity menu shortcut.

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would reword to "Opens the Vanity menu". Also, link to the vanity page

- ![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

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, would reword to be clear on what these do. "Opens the Mediate UI".

- ![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)

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hotbar mod is now redundant and should no longer be mentioned.

Binary file added docs/Features/img/hotbar/action_chain.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/action_meditate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/action_pyramids.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/action_respec.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/action_rest.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/action_si.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/action_vanity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/drawer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/five_bars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/group.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/loadouts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Features/img/hotbar/showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/hotbar/bindings_warning.png
Binary file not shown.
Binary file removed docs/img/hotbar/context_menu.png
Binary file not shown.
Binary file removed docs/img/hotbar/five_bars.png
Binary file not shown.
Binary file removed docs/img/hotbar/hotkeys.png
Binary file not shown.
Binary file removed docs/img/showcase/hotbar.PNG
Binary file not shown.
Binary file removed docs/img/showcase/hotbar_drawer.PNG
Binary file not shown.
37 changes: 4 additions & 33 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be removed now - the mod is completely redundant now that Epip works without EE


### 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.
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down