universalis-mcp-server 0.2.0 → 0.2.1

package/docs/wiki/saddlebag/ffxiv-advanced-undercut-alert-options.md

@@ -0,0 +1,123 @@
+You may want your undercut alerts to behave differently than normal to ignore additional items, handle HQ vs NQ differently, handle big stacks differently than your small stacks, ignore certain retainers, etc. Check out the solutions here and see if they solve the problem you have:
+
+- [You want to ignore some items that get undercut too often](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Advanced-Undercut-Alert-Options#you-want-to-ignore-some-items-that-get-undercut-too-often)
+- [You only want to be alerted on specific items](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Advanced-Undercut-Alert-Options#you-only-want-to-be-alerted-on-specific-items)
+- [You want to set up alerts for multiple servers](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Advanced-Undercut-Alert-Options#you-want-to-set-up-alerts-for-multiple-servers)
+- [You only want to be alerted on HQ undercuts for some items](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Advanced-Undercut-Alert-Options#you-only-want-to-be-alerted-on-hq-undercuts-for-some-items)
+- [I want to ignore annoying retainers](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Advanced-Undercut-Alert-Options#i-want-to-ignore-annoying-retainers)
+
+# You want to ignore some items that get undercut too often
+
+When you deal with constant undercutters on items like crafted gear the alerts can get annoying.  You can choose to not be alerted on those at all by ignoring them.
+
+1. On the undercut screen click `Filter out these items`
+
+![image](https://user-images.githubusercontent.com/17516896/228265500-90b11641-5466-4bb7-85d3-25d4d8996a04.png)
+
+2. Search for each item you want to ignore by name and select them from the dropdown
+
+![image](https://user-images.githubusercontent.com/17516896/228261531-7e4bbbce-6459-4b55-91ae-23f164e0f338.png)
+
+3. You will then see the item ids show up under the `ignore_ids` section of the json and you will no longer be alerted on those items
+
+![image](https://user-images.githubusercontent.com/17516896/228261592-accd6582-5891-4e97-8cea-12bbdc5dc246.png)
+
+# You only want to be alerted on specific items
+
+1. Under `I want to be alerted on these items` click the `Selected Items` option:
+
+![image](https://user-images.githubusercontent.com/17516896/228265393-b76caf3d-0770-412d-8c48-52a33d2474a6.png)
+
+2. Add the names of the specific items you want to be alerted on 
+
+<img width="425" alt="image" src="https://user-images.githubusercontent.com/17516896/228265983-5bd8cfe2-5758-4992-8380-c249bd819d81.png">
+
+You will now see the item ids show up in the `add_ids` section:
+
+<img width="327" alt="image" src="https://user-images.githubusercontent.com/17516896/228266157-00b74dc8-076a-4fc4-8298-68f878c790a4.png">
+
+
+# You want to set up alerts for multiple servers
+
+If you are a `Fancy Patreon` or higher you can get alerts for multiple servers. 
+
+1. use the [undercut alert info generator](https://saddlebagexchange.com/undercut) for each server you sell on. 
+2. After just add all of your json blobs into the list. Note that you will have one `seller_id` for all retainers across all characters in that entire server:
+
+```
+[
+    {
+        "seller_id": "myfirstid",
+        "server": "Famfrit",
+        "add_ids": [],
+        "ignore_ids": [],
+        "hq_only": false,
+        "ignore_data_after_hours": 720
+    },
+    {
+        "seller_id": "mysecondid",
+        "server": "Moogle",
+        "add_ids": [],
+        "ignore_ids": [],
+        "hq_only": false,
+        "ignore_data_after_hours": 720
+    }
+]
+```
+
+
+# You only want to be alerted on HQ undercuts for some items
+
+We know that for some items being undercut on an NQ item does not matter when you are selling an HQ item.
+
+The workaround is to use the `Selected Sales` option and make a list of all the HQ items you care about. Also check the `HQ only` box.
+
+<img width="600" alt="image" src="https://user-images.githubusercontent.com/17516896/227581130-f30e3d13-be91-49f8-a97c-fdadcc0ff0d6.png">
+
+This will give you the list of item ids for those HQ only items.  Next do the following:
+
+1. Put that list in `ignore_ids` for the undercut json that has `"hq_only": false,` 
+2. And then leave them in the `add_ids` for the `"hq_only": true,` one with `"ignore_ids": [-1],`
+3. Put them both in a list like this
+
+Then it will only alert on those specific item when its an hq undercut and all the rest of your items will alert on any undercut
+
+```
+[
+    {
+      "seller_id": "adfamyselleridadsfa",
+      "server": "Goblin",
+      "add_ids": [],
+      "ignore_ids": [37840,37842,37843,37844,37841,38929,38930,38261,38263,38264,38265,38266,38267,38268,37282,38270,38269],
+      "hq_only": false,
+      "ignore_data_after_hours": 24
+    },
+    {
+      "seller_id": "adfamyselleridadsfa",
+      "server": "Goblin",
+      "add_ids": [37840,37842,37843,37844,37841,38929,38930,38261,38263,38264,38265,38266,38267,38268,37282,38270,38269],
+      "ignore_ids": [-1],
+      "hq_only": true,
+      "ignore_data_after_hours": 24
+    }
+]
+```
+
+# I want to ignore annoying retainers
+
+For high competition items you may want to ignore that retainer to limit alerts or ignore someone elses retainer if they keep undercutting you and you are sick of it.
+
+All you have to do is add the `"ignore_retainers"` list and then add the names of all retainers you hate in there:
+
+```
+{
+      "seller_id": "adfasdfasdfasdfa",
+      "server": "Zodiark",
+      "add_ids": [],
+      "ignore_ids": [],
+      "hq_only": false,
+      "ignore_data_after_hours": 720,
+      "ignore_undercuts_with_quantity_over": 9999,
+      "ignore_retainers": ["Myannoyingretainer", "Anotherannoyingone"]
+}
+```

package/docs/wiki/saddlebag/ffxiv-experimental-discount-price-sniper.md

@@ -0,0 +1,7 @@
+Our **Experimental Discount Price Sniper** finds amazing deals and discounts which are streamed to a discord channel for [Fancy Patreons and higher tiers.](https://www.patreon.com/indopan)
+
+We use a customized formula to find amazing deals and discounts on valuable and fast moving items:
+
+<img width="554" alt="image" src="https://user-images.githubusercontent.com/17516896/232373449-2b47452b-572b-426a-b69f-ac0b7ae88272.png">
+
+<img width="650" alt="image" src="https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/fa91298b-c43a-46b7-8768-f161ba172035">

package/docs/wiki/saddlebag/ffxiv-job-category-ids.md

@@ -0,0 +1,13 @@
+```
+[
+    {"id": 0, "name": "Omnicrafter"},
+    {"id": 8, "name": "Carpenter"},
+    {"id": 9, "name": "Blacksmith"},
+    {"id": 10, "name": "Armorer"},
+    {"id": 11, "name": "Goldsmith"},
+    {"id": 12, "name": "Leatherworker"},
+    {"id": 13, "name": "Weaver"},
+    {"id": 14, "name": "Alchemist"},
+    {"id": 15, "name": "Culinarian"}
+]
+```

package/docs/wiki/saddlebag/ffxiv-sale-alerts.md

@@ -0,0 +1,48 @@
+# Description
+
+Our sale alerts monitor universalis for the items you are selling and will send an alert when an item has sold!
+
+<img width="540" alt="image" src="https://user-images.githubusercontent.com/17516896/233164800-96bc86fa-fe26-4d72-aacf-442d1332506b.png">
+
+# Setup
+
+There are 2 ways to get sale alert data:
+
+1. You can get this data using [Dalamund Plugins and the plugin Allagan Tools.](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Allagan-Tools-Inventory-Analysis#sale-and-undercut-alert-json-data) 
+2. [The undercuts alert page also generates sale alerts](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Undercut-Alerts---Alpha-version#setup)
+
+When using either search we will generate the sale alert data similar to the following:
+
+```
+{
+  "item_ids":[21826,20744,35562,2731,7148,3023,35984,29682,7986,39378,2642,6460,4311,35573,6459,2236,30813,39391],
+  "retainer_names":["my retainer","my other retainer","my other other retainer"],
+  "server":"Famfrit"
+}
+
+```
+
+This data includes:
+- A list of the item ids of all items you are selling, or empty list to start.
+- Your home server
+- A list of your retainers names
+
+We will search universalis in the listings of these items every 5 min and when we no longer find your retainer names in the listing data of an items you are selling then we will send an alert! This alert will contain the item name, universalis link and minimum price.
+
+Note that there may be false positives when universalis is out of date and no longer finds your listings, this can happen whenever you pull your retainer off the marketboard to update prices.  So remember to always search the listings in game after updating item prices to insure universalis has the most up to date data.  
+
+It also helps to turn off sale alerts when you are in your retainer menus.
+
+# Discord bot
+
+Give this to the discord bot to get alerts 
+
+<img width="1032" alt="image" src="https://github.com/user-attachments/assets/7d71bfe0-93f4-43d3-a673-2fc8587c70bf" />
+
+<img width="557" alt="image" src="https://github.com/user-attachments/assets/2d45674b-4740-4620-a55b-4b78ac795bd6" />
+
+<img width="453" alt="image" src="https://github.com/user-attachments/assets/64dcc096-1a36-4d9b-820e-3e0e35ea3886" />
+
+<img width="553" alt="image" src="https://github.com/user-attachments/assets/a275dcf3-5dd9-4530-9d0e-0ef96342e755" />
+
+

package/docs/wiki/saddlebag/ffxiv-sale-leads.md

@@ -0,0 +1,42 @@
+# Sales-Qualified Leads!
+
+Our ultimate gil earning tool the [FFXIV Secret Sale Leads](https://en.wikipedia.org/wiki/Lead_generation) will find buyers for you!
+
+Think of it as video game door to door sales.  Which might seem odd, but it is the single most profitable opportunity in all of FFXIV!
+
+Who needs retainers or the marketboard when you have customers ready and waiting for your goods, willing to spend up to and over 10,000,000 gil at a time! 
+
+With sale leads:
+* You can sell to any buyers region wide.
+* There is no tax on direct sales.
+* Sales are instant!
+* There is no retainer item limit to deal with.
+* Establishing good customer relations can lead to even more direct purchases in the future!
+
+# Easy Mode
+
+The easy way to do this is:
+
+1. Wait until our leads find a buyer (these messages will show up in the discord channel)
+2. Travel to their server 
+3. Do a /tell and ask them if they need more of the items they just bought.  
+
+Often they will buy a ton more off you :)
+
+# Additional Details: How does this work?
+
+This finds opportunities for you to go directly up to someone in game and ask if they would like to purchase the items you have to sell.  All gil earned is made by direct trading between you and the other player.  This is not a gil trading service and it is not a bot managed service. 
+
+All we do is find potential buyers for you. 
+
+Based on past purchases we can predict when players are likely to make additional purchases for similar goods.  Normally with the marketboard you would wait for the buyer to come to you. With a sale lead you are going to the buyer!
+
+For example if someone buys a ton of furniture, then they probably have a new house.  New home owners often need more items to decorate then their server can provide. Which means they might be looking to buy your furniture!
+
+# Where to find the sale leads?
+
+We have several discord channels in the [**FFXIV Patreon** section of our discord](https://discord.gg/Pbp5xhmBJ7) separated by region and type of buyer. All you have to do is travel to the buyers server /tell to talk to the buyers and ask if they would like to buy any items our sale leads recommend. 
+
+If you want more info just ask any of our devs with the `@team` rank to teach you how to get rich using our leads!
+
+Join [our patreon](https://www.patreon.com/indopan) today to get access or get a one week free trial by running `/free-trial` in our [discord](https://discord.gg/Pbp5xhmBJ7)!

package/docs/wiki/saddlebag/how-to-trade-using-our-ffxiv-market-overview.md

@@ -0,0 +1,102 @@
+Our [Market overview](https://saddlebagexchange.com/ffxiv/marketshare/queries) will show you the top 200 best items to sell on the marketboard from a number of different categories! Here you will see the best items to sell on the market board from a range of numbers to different categories! Here is where you can view items that earn the most gil, increasing in price the most, fastest selling, the most purchased, highest quality sold, and the highest average/median/minimum prices!
+
+![image](https://user-images.githubusercontent.com/17516896/225352949-d52f8a1e-fd08-4f51-aa1a-8df282bb38e4.png)
+
+# How to earn gil with the market overview
+
+## TLDR:
+
+The simplest way to earn gil with this is by selling items that are ***green*** or ***blue**** in the price overview. (These have increased in price or are out of stock, making them much more profitable to buy on other servers to sell on your own or craft/gather.)
+
+``Tip: If it's blue it means they are extremely profitable to sell as none are listed on your market board and you can sell for any price you want to.``
+
+First... pick a search. The weekly overview, price percent increase or fast-selling searches are great places to start. You can make your own search by changing the numbers, however, we have created searches with defaults open for public usage under the [main page for the market overviews.](https://saddlebagexchange.com/ffxiv/marketshare/queries)
+
+
+Then here is how you read the chart:
+
+*  Big boxes with a big current market value **earn lots of gil.** They are good items to buy/resell, craft, or gather
+*  Little boxes with a small current market value are bad items to buy/resell, craft, or gather. (They don't earn much gil.)
+*  _When the price overview is bright green:_ You should buy/resell, craft or gather and sell at __current prices__ to **earn lots of gil**
+*  **Stay far away from items that are bright red!!!**: They are probably unprofitable, have crashed in price, or only show big gil earned due to gil laundering which does not show real sales.
+*  **_When the price overview is light blue:_** **These items will earn high amounts of gil.** This is the best opportunity to buy/resell, craft, or gather!!! This lets you sell at any price you want to.  
+*  Here's a link to find that [history overview](https://saddlebagexchange.com/queries/item-history) search to find specific items on the *Region Price History* chart. Check out [our guide on this](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-use-Item-Data-Searches-to-help-you-find-good-items-to-trade) for more info on how to use our history overview. 
+
+## How to search for items
+
+The market overview has several options which point out the *best* selling item based on a number of categories __depending__ on the search inputs you pick:
+
+![image](https://user-images.githubusercontent.com/17516896/225358969-1b234617-eac9-4887-a446-6fc87d715d45.png)
+
+* The `Sales Amount` divided by the `Time Period` gives you the sales per hour or sale rate. (i.e. how fast an item sells.)
+* `Time Period` is how much time you want to search over. You can search from 1 to 168 hours. (24 hours is one day, and 168 hours is one week.)
+* The `Sales Amount` is how many sales you want to find in that time period, you can pick from 1 to a max of 40 sales (we only store 40 sales in our DB, for finding data on any items selling 40 or more sales we make API calls to universalis.)
+* As the most sales you can pick is 40 if you want faster-selling items then pick a lower `Time Period` to find faster sale rates.
+* `Average Price` will find items that sell on average for that price or higher. The lowest amount of gil you can search for is 10 gil.
+* The Item Filters will let you filter specific categories of items or multiple categories at once. Make sure to unselect the `All` checkbox if you want to search for specific categories
+
+The `Sort Results By` is most important as it will change the results you see. To make sure our chart load correctly we only pick the top 200 items sorted by the value of the field you pick in the `Sort Results By` option:
+
+* **Market Value:** * Simplest metric to use. Shows what items earned the most gil by adding together all sales revenue from all items that match search input to show the 200 top earners.
+* **Percent Changed:** Highlights what is out of stock or has increased in price. (These are great opportunities to trade when buying from other servers to sell on your own.)
+* **Purchase Amount:** This shows you the fastest-selling items. (Commonly the best items are sold within stacks of 1 or small stacks, but they are also the easiest to sell fast)
+* **Quantity Sold:** This shows the items that sell the highest stacks the fastest (these are commonly fast-selling items that sell in stacks of 99 for common commodities or 9999 for crystals)
+* **Average Price:** This shows the items which on average sell for the most gil, however, some very big sales can offset this.
+* **Median:** This shows which items sell for the most gil on a regular basis and it's more consistent than the average price.
+
+## Using the statistics table
+
+![image](https://user-images.githubusercontent.com/17516896/225390829-18d70faa-4348-480a-9bd7-ef692052cb02.png)
+
+The table below the heat map has columns that can be sorted (by clicking on the columns) and contains all the data on items with helpful links such as:
+
+* Item Name: Name of the item
+* Market Value: The amount of gil earned in the time period selected
+* Percent Changed: The change in price vs the average price
+* Market State: [See the info on this from the heatmap section](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-trade-using-our-FFXIV-Market-Overview#using-the-heatmap-tabs)
+* Average Price: Average price in the time selected
+* Median: Median price in the time selected
+* Minimum Price: Current minimum price
+* Purchase Amount: Amount of sales (i.e. individual purchases when users click buy on an item)
+* Quantity Sold: Quantity sold (only important for items sold in stacks of more than 1)
+* Item data: A link to all our charts and stats that help you decide if an item is a good one to sell
+* Universalis Link: A link to see the item on universalis
+* NPC Vendor: A link to the vendor info if the item is sold by a vendor in-game
+
+## Using the heatmap tabs
+
+Clicking the different tabs on top of the heat map will show you different stats with boxes colored by price percent increase.
+
+The colors are assigned by the current min price vs the average price:
+* Blue for out of stock
+* Bright green for `spiking prices` over a 66% price increase
+* Dark green for `increasing prices` 15% to 66% increase
+* Yellow for `stable prices` around -15% to 15%
+* Dark red for `decreasing prices` -15% to -66%
+* Bright red for `crashing prices` under -66%
+
+Market Overview shows you the best items overall that earned the most gil:
+
+![image](https://user-images.githubusercontent.com/17516896/225380594-5702336d-ab0a-4e73-ba41-652b09df21e3.png)
+
+A price percent increase is best for seeing which items are the best to trade, it favors out of stock which appears the largest
+
+![image](https://user-images.githubusercontent.com/17516896/225384652-169a6ea1-c586-4a70-b9f8-87b3289c0165.png)
+
+This is most useful when using the `Sort Results by` option for the [Highest Price Percent Increases Weekly](https://saddlebagexchange.com/ffxiv/marketshare?timePeriod=168&salesAmount=3&averagePrice=10000&filters=0&sortBy=percentChange), which shows dozens of high value out of stock items or items at such a high price they might as well be out of stock.
+
+![image](https://user-images.githubusercontent.com/17516896/225385163-50774980-edfb-43d3-b702-e818064225bf.png)
+
+Purchase amount shows you which items had the most individual sales (i.e. most people clicking buy on them) (top selling Materia often appear here)
+
+![image](https://user-images.githubusercontent.com/17516896/225391244-03873838-3bb6-4676-bef2-471519e76b5b.png)
+
+Quantity sold shows the items sold the most bulk in the largest stacks (crystals appear here when you set a low price as they sell in stacks of 9999)
+
+![image](https://user-images.githubusercontent.com/17516896/225391952-c11a99ec-62a8-4c60-8fac-13b804ee89e5.png)
+
+The other tabs will show the top median/average prices but you can get the same info from the statistics table below
+
+
+
+

package/docs/wiki/saddlebag/how-to-use-the-ffxiv-crafting-profit-simulator-craftsim.md

@@ -0,0 +1,88 @@
+# [ Watch the video guide!](https://www.youtube.com/watch?v=6wyHmxMr6Y8)
+
+# Overview
+
+Our [Crafting Profit Simulator](https://saddlebagexchange.com/ffxiv/craftsim/queries) (based on the wow addon craftsim profit search) will search for the most profitable items you can craft!
+
+<img width="880" alt="image" src="https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/d33f51d8-c497-4473-b632-25381e5b76b7">
+
+# Search Menu Options
+
+This search is based on the inputs you choose from our search menu. 
+
+<img width="674" alt="Screen Shot 2023-09-03 at 5 37 49 PM" src="https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/41246f2b-94d9-44d2-a83e-8cd14c04ac6e">
+
+
+## Main Search Options
+
+The main search options include:
+
+- `Home Server`: for the server you will be selling on
+- `Item Category`: if you want to search for a specific category (multi category select is available in the API but not in the temporary frontend)
+- `DoH`: where you pick which job you want to search recipes on or select `Omnicrafter` to search all crafting recipes. 
+- `sales_per_week`: to filter items by a minimum amount of regional sales per week (increase this for faster selling items)
+- `median_sale_price `: to filter items by a minimum median regional sale price per unit (increase this for more valuable items)
+- `max_material_cost`: to filter out items with too high of a crafting cost (lower this value if you are poor)
+
+## Cost and Revenue Options
+
+The most important search options are the `Cost` and `Revenue` options. These allow you to select which metrics you wish to use for profit calculations:
+
+<img width="445" alt="image" src="https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/c9f55281-c004-46f2-bee6-6d69f20b2a71">
+<img width="438" alt="image" src="https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/ac8005b4-1f08-427e-b229-cd74f1d14c24">
+
+For costs the tldr; is that the `Costs: based on materials regional median sale price` option is most realistic. If the `Costs: based on materials current regional minimum listing price` option is way lower than the median and you might find some good deals on a few materials, but you will not realistically find all the materials you need at that cost. The true cost of a craft is likely somewhere in between the **Median Cost** and **Minimum Listing Price** options if you shop around or use our [crafter shopping list tool](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Temp-%E2%80%90-How-to-use-FFXIV-Shopping-List)
+
+All cost options include:
+
+- `Costs: based on materials regional median sale price` Will estimate crafting ingredient costs based on the regional median sale price of each ingredient needed. This is typically the most common price found and the realistic metric to use if you are shopping on multiple servers for the best price in your region.
+- `Costs: based on materials regional average price` Will estimate crafting ingredient costs based on the regional average sale price of each ingredient needed. This is a more pessimistic and higher cost as it takes into account "lazy" sales that happen when people buy materials for higher price on their local marketboard instead of shopping around.
+- `Costs: based on materials current regional minimum listing price` Will estimate crafting ingredient costs based on the current regional minimum listing price each ingredient needed. This is often lower than what you may find as a single listing posted at a very low price can throw off the calculation.  This may be a very large and expensive bulk stack at a low price per unit with far more materials than you need or it may be a single small stack that will be far less materials than you need.
+
+For revenue options the tldr; is that you should use the `Revenue: based on current home server minimum listing prices` option as you should probably attempt to sell at the current price on your server for the most potential profit. You might get undercut doing this, but thats not an issue if you use our [undercut alerts](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Undercut-Alerts---Alpha-version).  
+
+All revenue options include:
+
+- `Revenue: based on current home server minimum listing prices` to assume you can sell for the current listing price on your server. This will be the most profitable option, but with the most competition.
+- `Revenue: based on current regional minimum listing prices` this is the most realistic option. When you sell at or below the lowest price in your region this will attract buyers from other server to come to you! You will have far less competition and far more sales. Anything you can profit on while being the cheapest in the whole region is absolutely a good item to craft and sell!
+- `Revenue: based on item regional median sale price` this price will also be very realistic. You should pick this if you want to sell at a low price for more sales. This will be higher than the regional minimum price.  
+- `Revenue: based on item regional regional sale price` pick this if you are attempting to sell at a high price close to or at your servers the minimum listing price. While the home server minimum listing price will be higher than this value, when attempting to sell that high you will probably be undercut a few times driving the price down until you sell closer to the average price.
+
+## Advanced Options
+
+These options will likely go in an `advanced options` drop down when going in the main website.  These are very situational.
+
+- `stars` to only search for recipes with this many stars or higher
+- `lvl_lower_limit` to filter out low level crafts that may have more crafters and competition
+- `lvl_upper_limit` to filter out high level crafts if you are still leveling a job and do not have the max level with all recipes unlocked
+- `yields` to only search for recipes that make multiple items per craft (ex: [Tincture of Strength](https://www.garlandtools.org/db/#item/27786))
+- `hide_expert_recipes` to hide any expert level crafts that are not guaranteed to craft the desired item (ex: [Water Otter Fountain Lumber](https://www.garlandtools.org/db/#item/37699))
+
+# Search Results Table
+
+After searching you will be given a table of potential crafts to search through.
+
+You can search for items by name with the search bar.  You can also sort the list by clicking on any of the columns. You should probably sort by `profitEst` for more gil or `soldPerWeek` for faster sales.
+
+Main Site
+![image](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/062ee4e2-2d31-47ef-a9bb-9682f6e12be0)
+
+Alpha Site
+<img width="843" alt="image" src="https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/9d2898bc-90cd-471b-bc47-8c71bf3bda05">
+
+
+The full column list is:
+- `itemName`: the name
+- `hq`: if the prices are for HQ or NQ craft of the item
+- `yields`: the number of items made per craft
+- `item-data`: [a link to our custom statistics to tell you everything you need to know about how good an item is to sell.](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-use-Item-Data-Searches-to-help-you-find-good-items-to-trade)
+- `universalisLink`: a link to the item on universalis
+- `material - current region min listing cost`: the crafting cost assuming you can buy all materials at the current minumum listing price
+- `material - median regional cost`: the crafting cost assuming you can buy all materials at the current median regional sale price
+- `material - average regional cost`: the crafting cost assuming you can buy all materials at the current average regional sale price
+- `revenue - current home server min listing price`: the revenue made if you can sell at your home servers current minumum listing price
+- `revenue - current regional min listing price`: the revenue made if you can sell at your home regions current minumum listing price across all servers
+- `revenue - regional median sale price`: the revenue made if you can sell at your home regions current median sale price
+- `revenue - regional average sale price`: the revenue made if you can sell at your home regions current average sale price
+
+

package/docs/wiki/saddlebag/item-categories-ids-and-list.md

@@ -0,0 +1,217 @@
+# our custom category ints
+
+used for our own purposes will start at 0 and then use negative numbers for new categories we create
+```
+0  Return all items
+-1 Items sold by vendors
+-2 'supply and provision' # https://ffxiv.gamerescape.com/wiki/Supply_and_Provisioning_Mission
+-3 'crafter quest item'  # https://ffxivgillionaire.com/crafter-class-quest-items-guide
+-4 NPC Vendor Furniture
+-5 Current Crafted Gear (used to exclude it from glamor searches)
+-666 Gil Laundering Items (exclude items used for gil laundering more often than actual sales)
+```
+
+# main category id list
+
+```
+1 Arms
+2 Tools
+3 Armor
+4 Accessories
+5 Medicines & Meals
+6 Materials
+7 Other
+```
+
+# sub category id list 
+```
+9 Pugilist's Arms
+10 Gladiator's Arms
+11 Marauder's Arms
+12 Archer's Arms
+13 Lancer's Arms
+14 Thaumaturge's Arms
+15 Conjurer's Arms
+16 Arcanist's Arms
+17 Shields
+19 Carpenter's Tools
+20 Blacksmith's Tools
+21 Armorer's Tools
+22 Goldsmith's Tools
+23 Leatherworker's Tools
+24 Weaver's Tools
+25 Alchemist's Tools
+26 Culinarian's Tools
+27 Miner's Tools
+28 Botanist's Tools
+29 Fisher's Tools
+30 Fishing Tackle
+31 Head
+33 Body
+35 Legs
+36 Hands
+37 Feet
+39 Necklaces
+40 Earrings
+41 Bracelets
+42 Rings
+43 Medicine
+44 Ingredients
+45 Meals
+46 Seafood
+47 Stone
+48 Metal
+49 Lumber
+50 Cloth
+51 Leather
+52 Bone
+53 Reagents
+54 Dyes
+55 Weapon Parts
+56 Furnishings
+57 Materia
+58 Crystals
+59 Catalysts
+60 Miscellany
+65 Exterior Fixtures
+66 Interior Fixtures
+67 Outdoor Furnishings
+68 Chairs and Beds
+69 Tables
+70 Tabletop
+71 Wall-mounted
+72 Rugs
+73 Rogue's Arms
+74 Seasonal Miscellany
+75 Minions
+76 Dark Knight's Arms
+77 Machinist's Arms
+78 Astrologian's Arms
+79 Airship/Submersible Components
+80 Orchestrion Components
+81 Gardening Items
+82 Paintings
+83 Samurai's Arms
+84 Red Mage's Arms
+85 Scholar's Arms
+86 Gunbreaker's Arms
+87 Dancer's Arms
+88 Reaper's Arms
+89 Sage's Arms
+90 Registrable Miscellany
+105 Blue Mage's Arms
+91 Viper's Arms
+92 Pictomancer's Arms
+```
+
+# sub categories ids to main categories
+1. Arms
+```
+9 Pugilist's Arms
+10 Gladiator's Arms
+11 Marauder's Arms
+12 Archer's Arms
+13 Lancer's Arms
+14 Thaumaturge's Arms
+15 Conjurer's Arms
+16 Arcanist's Arms
+73 Rogue's Arms
+76 Dark Knight's Arms
+77 Machinist's Arms
+78 Astrologian's Arms
+83 Samurai's Arms
+84 Red Mage's Arms
+85 Scholar's Arms
+86 Gunbreaker's Arms
+87 Dancer's Arms
+88 Reaper's Arms
+89 Sage's Arms
+105 Blue Mage's Arms
+91 Viper's Arms
+92 Pictomancer's Arms
+```
+
+2. Tools
+
+```
+19 Carpenter's Tools
+20 Blacksmith's Tools
+21 Armorer's Tools
+22 Goldsmith's Tools
+23 Leatherworker's Tools
+24 Weaver's Tools
+25 Alchemist's Tools
+26 Culinarian's Tools
+27 Miner's Tools
+28 Botanist's Tools
+29 Fisher's Tools
+30 Fishing Tackle
+```
+
+3. Armor
+
+```
+17 Shields
+31 Head
+33 Body
+35 Legs
+36 Hands
+37 Feet
+```
+
+4. Accessories
+
+```
+39 Necklaces
+40 Earrings
+41 Bracelets
+42 Rings
+```
+
+5. Medicines & Meals
+
+```
+43 Medicine
+44 Ingredients
+45 Meals
+46 Seafood
+```
+
+6. Materials
+
+```
+47 Stone
+48 Metal
+49 Lumber
+50 Cloth
+51 Leather
+52 Bone
+53 Reagents
+54 Dyes
+55 Weapon Parts
+```
+
+7. Other
+
+```
+56 Furnishings
+57 Materia
+58 Crystals
+59 Catalysts
+60 Miscellany
+65 Exterior Fixtures
+66 Interior Fixtures
+67 Outdoor Furnishings
+68 Chairs and Beds
+69 Tables
+70 Tabletop
+71 Wall-mounted
+72 Rugs
+74 Seasonal Miscellany
+75 Minions
+79 Airship/Submersible Components
+80 Orchestrion Components
+81 Gardening Items
+82 Paintings
+90 Registrable Miscellany
+```