Skip to content

Commit ec4fd75

Browse files
authored
Add topbar icon
Signed-off-by: GitHub <noreply@github.com>
1 parent 528d7e3 commit ec4fd75

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/assets/disable-topbar.png

39.6 KB
Loading

docs/guide.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,14 @@ local HOTBAR_SLOTS_MINI = 5 -- (1)!
5656

5757
![Screenshot of the hotbar and inventory with modified mini size](assets/hotbar-inventory-sample.png)
5858

59+
## Removing Topbar Icon
60+
61+
The topbar icon is decoupled from Purse's functionality, so you can remove it by disabling the [`TopbarIcon`](https://github.com/ryanlua/purse/blob/main/src/TopbarIcon.client.luau) script. In addition, a [`ContextAction`](https://github.com/ryanlua/purse/blob/main/src/ContextAction.client.luau) script is included to bind opening and closing the inventory to a keycode (set to backquote <kbd>`</kbd> by default).
62+
63+
Your explorer window should look similar to the following when you disable the `TopbarIcon` script and enable the `ContextAction` script.
64+
65+
![Explorer window showing TopbarIcon disabled and ContextAction enabled under Purse](assets/disable-topbar.png)
66+
67+
!!! warning
68+
69+
If you do not enable the `ContextAction` script, players will not be able to open the backpack since the topbar icon which handles binding is disabled.

0 commit comments

Comments
 (0)