### statCapWithJob formula and worked example Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/docs/xiv-docs/Item-Level-Syncing.md The statCapWithJob formula from xivmath.ts, followed by a worked example for an i530 Edenmorn Hat of Casting in an i270 duty, computing a Vitality cap of 56. The formula is derived from testing and may not match the actual server-side formula. ```ts round(floor(floor(ilvlModifier * meldParam / 100) * baseParamModifierSlotModifier / 100) / 10); ``` ```ts round(floor(floor(736 * 90 / 100) * 85 / 100) / 10); round(floor(floor(662.4) * 85 / 100) / 10); round(floor(662 * 85 / 100) / 10); round(floor(562.7) / 10); round(562 / 10); round(56.2); 56 ``` -------------------------------- ### GET /shortlink/{id} Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/API_DOC.md Retrieves base data for a gear set or sheet using a shortlink ID. This is the legacy method for retrieving data. ```APIDOC ## [GET] /shortlink/{id} ### Description Retrieves base data for a gear set or sheet using a shortlink ID. This is the legacy method for retrieving data and is maintained for backwards compatibility. ### Method GET ### Endpoint https://api.xivgear.app/shortlink/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The shortlink ID (e.g., `cd2c8bf4-1fa2-4197-88f5-f305b9a93bdf`). ### Request Example GET https://api.xivgear.app/shortlink/cd2c8bf4-1fa2-4197-88f5-f305b9a93bdf ### Response #### Success Response (200) Returns a TopLevelExport object which resolves to either a SheetExport or SetExport. #### Response Example { "type": "TopLevelExport", "data": {} } ``` -------------------------------- ### HTML iframe Embed Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/docs/How_to_Embed.md HTML iframe example for embedding a Xivgear set on other sites. The iframe uses the embed URL as the src attribute and includes a title attribute. ```html ``` -------------------------------- ### Build, test, and run commands Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/LOCAL_BUILD.md Run these commands in a command line. `pnpm i` is only needed once or when dependencies change. `pnpm serve` runs the local dev server with automatic reloading; `pnpm -F @xivgear/gearplan-frontend less` rebuilds CSS as an example of a sub-package task. ```shell # Only needed once, or when dependencies change pnpm i # Build/rebuild pnpm build # Run tests pnpm test # Run Local Dev Server pnpm serve # Rebuild CSS - example of running a specific sub-package task pnpm -F @xivgear/gearplan-frontend less # See package.json at the top level as well as in each sub-project for more tasks you can run. ``` -------------------------------- ### Example Embed URL Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/docs/How_to_Embed.md Shows the format of an embed URL generated for a specific set. The URL includes the page parameter with encoded slashes and the onlySetIndex parameter to select a specific set. ```text https://xivgear.app/?page=embed%7Csl%7C154b353b-bf04-4399-8e3c-d7da7e6e0fca&onlySetIndex=3 ``` -------------------------------- ### GET /fulldata/{path} Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/API_DOC.md Retrieves full data including derived information for a gear set or sheet using a UUID or bis link path. This is the legacy method for retrieving full data. ```APIDOC ## [GET] /fulldata/{path} ### Description Retrieves full data including derived information for a gear set or sheet using a UUID or bis link path. This is the legacy method for retrieving full data and is maintained for backwards compatibility. ### Method GET ### Endpoint https://api.xivgear.app/fulldata/{path} ### Parameters #### Path Parameters - **path** (string) - Required - The set UUID (e.g., `f9b260a9-650c-445a-b3eb-c56d8d968501`) or a bis link path (e.g., `bis/sge/endwalker/anabaseios`). ### Request Example GET https://api.xivgear.app/fulldata/f9b260a9-650c-445a-b3eb-c56d8d968501 ### Response #### Success Response (200) Returns a SheetStatsExport object containing the full data including derived stats. #### Response Example { "type": "SheetStatsExport", "data": {} } ``` -------------------------------- ### GET /basedata Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/API_DOC.md Retrieves base data (user-specified gear items and materia) for a gear set or sheet. Accepts a full URL, page path, or individual parameters. ```APIDOC ## [GET] /basedata ### Description Retrieves the base data (user-specified gear items and materia) for a gear set or sheet. Use this endpoint when you only need the user-specified data without derived statistics. ### Method GET ### Endpoint https://api.xivgear.app/basedata ### Parameters #### Query Parameters - **url** (string) - Optional - A full URL to the gear set or sheet page. - **page** (string) - Optional - A page path (e.g., `sl|f9b260a9-650c-445a-b3eb-c56d8d968501`). - **partyBonus** (number) - Optional - Override the party bonus. Specify as a number, e.g., `?partyBonus=3`. - **onlySetIndex** (number) - Optional - Override the set index. Specify as a number, e.g., `?onlySetIndex=2`. ### Request Example GET https://api.xivgear.app/basedata?url=https%3A%2F%2Fxivgear.app%2F%3Fpage%3Dsl%7Cf9b260a9-650c-445a-b3eb-c56d8d968501%26onlySetIndex%3D1 ### Response #### Success Response (200) Returns a SheetStatsExport object containing the base data. #### Response Example { "type": "SheetStatsExport", "data": {} } ``` -------------------------------- ### GET /fulldata Source: https://github.com/xiv-gear-planner/gear-planner/blob/main/API_DOC.md Retrieves full data including derived information such as computed stats for a gear set or sheet. This endpoint is slower than /basedata and should only be used when derived data is needed. ```APIDOC ## [GET] /fulldata ### Description Retrieves full data including derived information such as computed stats for a gear set or sheet. Use this endpoint when you need derived statistics in addition to the base data. ### Method GET ### Endpoint https://api.xivgear.app/fulldata ### Parameters #### Query Parameters - **url** (string) - Optional - A full URL to the gear set or sheet page. - **page** (string) - Optional - A page path (e.g., `sl|f9b260a9-650c-445a-b3eb-c56d8d968501`). - **partyBonus** (number) - Optional - Override the party bonus. Specify as a number, e.g., `?partyBonus=3`. - **onlySetIndex** (number) - Optional - Override the set index. Specify as a number, e.g., `?onlySetIndex=2`. ### Request Example GET https://api.xivgear.app/fulldata?url=https%3A%2F%2Fxivgear.app%2F%3Fpage%3Dsl%7Cf9b260a9-650c-445a-b3eb-c56d8d968501%26onlySetIndex%3D1 ### Response #### Success Response (200) Returns a SheetStatsExport object containing the full data including derived stats. #### Response Example { "type": "SheetStatsExport", "data": {} } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.