Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
espositos committed Nov 2, 2020
1 parent 6d477b1 commit 1f7e088
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
15 changes: 15 additions & 0 deletions custom_categories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
The custom categories feature is half-baked but I don't really intend to develop it further, so if it doesn't do what you need I'm sorry in advance; I hope you can find another solution. The only real 'actions' you can add to the HUD yourself are macros, or you can link to certain compendiums (Macro, RollTable, JournalEntry, or Playlist compendiums). Having said that, here is how you can do that.

![image](https://user-images.githubusercontent.com/14127543/95023423-439d6800-067d-11eb-8131-1087d7032989.png)
(1) You can add new **subcategories** to the existing core **categories** (the HUD buttons that are always visible: inventory, spells, etc) by clicking on the category button. or
(2)If you want to add them in a new category, first click on the 'book' icon on the right side of HUD and enter the name of any new categories you'd like to add. There's not a lot of control as to where they appear but you can choose to place them on the right or the left of the core categories.

![macro_example](https://user-images.githubusercontent.com/14127543/95023702-c4a92f00-067e-11eb-8ec0-37f610e74847.gif)
When you click on the category, you'll be presented with a dialogue that will suggest subcategories. These suggestions are just compendiums you have permission to view and are supported (see above).

If ignore the suggestions and just enter your own text, it will add an empty subcategory to the HUD category. This is probably what you want.

![image](https://user-images.githubusercontent.com/14127543/95023808-5a44be80-067f-11eb-9fd7-ccfcbb443d31.png)
Click on the subcategory title and you can then add Macros to the new subcategory. These macros are drawn from the Macros Directory and the user should have permission to see them/run them. So any actions you want to add, first make a macro for it.

That's about it. If you add a compendium, clicking on the subcategory title will also allow you to filter the compendium entries.
3 changes: 3 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Once activated, selecting a token that has an actor/character sheet associated w
Offers a variety of settings including support for third-party roll handlers (Please contact me if you'd like to add yours, or improve the functionality of those offered), and can be repositioned.
![Customizable settings](.github/readme/tah-settings_and_repositioning.gif)

## Custom Categories
[Using custom categories](custom_categories.md)

## Support for WFRP
![Warhammer Fantasy Roleplay 4E](.github/readme/tah-wfrp.gif)

Expand Down

0 comments on commit 1f7e088

Please sign in to comment.