update userguide with item explorer and homeworld info

akarras · Jan 16, 2024 · c70cc42 · c70cc42
1 parent 3ca6f59
commit c70cc42
Show file tree

Hide file tree

Showing 11 changed files with 53 additions and 8 deletions.
diff --git a/userguide/src/SUMMARY.md b/userguide/src/SUMMARY.md
@@ -1,5 +1,8 @@
 # Summary
-- [Intro](./intro.md)
+- [Intro](./intro/intro.md)
+    - [Set your home world](./intro/homeworld.md)
+- [Search](./search/search.md)
+- [Item Explorer](./item_explorer.md)
 - [Characters]()
     - [Add character]()
 - [Retainers](./retainers/retainers.md)

diff --git a/userguide/src/images/item_explorer.png b/userguide/src/images/item_explorer.png
diff --git a/userguide/src/images/items_page.png b/userguide/src/images/items_page.png
diff --git a/userguide/src/images/items_view.png b/userguide/src/images/items_view.png
diff --git a/userguide/src/intro.md b/userguide/src/intro.md
diff --git a/userguide/src/intro/homeworld.md b/userguide/src/intro/homeworld.md
@@ -0,0 +1,12 @@
+# Setting a home world (and price zone)
+
+To make the most out of Ultros, you should set your homeworld. This will enable prices to show up in [search](../search/search.md), and within the [item explorer](../item_explorer.md).
+
+On the website, head to [settings](https://ultros.app/settings) and you should see a page like this.
+
+![homeworld settings](./homeworld_settings.png)
+
+Simply choose your world and price zone and you should start to see prices show up in search.
+![search example](./search_example.png)
+
+Note that this will have to be done on each device that you access Ultros from as currently this is not stored in the database but just stored as a local cookie.
diff --git a/userguide/src/intro/homeworld_settings.png b/userguide/src/intro/homeworld_settings.png
diff --git a/userguide/src/intro/intro.md b/userguide/src/intro/intro.md
@@ -0,0 +1,12 @@
+# Intro
+
+Ultros is a performant marketboard tool for Final Fantasy 14.
+
+## Discord bot
+
+To make the most out of ultros, you should consider [inviting the Discord bot](https://ultros.app/invitebot). The website is mostly more featured than the bot, with the exception of [alerts](./retainers/alerts.md), which only work on Discord.
+
+If you come across parts of this guide that need improvement, feel free to raise an issue in the [discord](https://discord.gg/pgdq9nGUP2), or via the [github issues](https://github.com/akarras/ultros/issues)
+
+
+
diff --git a/userguide/src/intro/search_example.png b/userguide/src/intro/search_example.png
diff --git a/userguide/src/item_explorer.md b/userguide/src/item_explorer.md
@@ -0,0 +1,24 @@
+# Item Explorer
+
+Ultros' item explorer is useful when you want to find items that you might not know the name of. It allows you to sort by price, ilvl, name, or when it was added to the game.
+
+Note: The item explorer is only available via the website.
+
+## Navigating to the item explorer
+To use to the item explorer, click the wrench and screwdriver next to the search box.
+![button next to search](./images/item_explorer.png)
+
+From there you can select an item category. The first several categories will match the categories found on the ingame marketboard, and the last buttons will just show you all of the gear that is available for a class.
+![item not found](./images/items_page.png)
+
+## Sorting
+
+The following sorting options are available
+- ADDED - When the item was added to the games files (this may not always make sense)
+- PRICE - (note: By default, the item explorer will use prices from your price zone- see [set your home world](./intro/homeworld.md) for how to configure)
+- NAME - Sorts alphabetically by the item's name
+- ILVL - Sorts by the most expensive
+
+This enables you to search for say, [the most expensive minion](https://ultros.app/items/category/Minions?sort=price), or the [most recently added samurai gear](https://ultros.app/items/jobset/SAM?sort=key)
+
+![Example of item explorer](./images/items_view.png)
diff --git a/userguide/src/search/search.md b/userguide/src/search/search.md
@@ -0,0 +1 @@
+# Search