added README.md file with project overview and setup instructions.
All checks were successful
Build and Release / Build (push) Successful in 29s
All checks were successful
Build and Release / Build (push) Successful in 29s
Removed item lookup for glasses
This commit is contained in:
59
README.md
Normal file
59
README.md
Normal file
@@ -0,0 +1,59 @@
|
||||
# GlamourBrowser
|
||||
|
||||
A Dalamud plugin for Final Fantasy XIV that provides an intuitive visual browser for equipment items and glamour customization.
|
||||
|
||||
## Features
|
||||
|
||||
- **Visual Item Browser** - Browse all equippable items with icon previews organized by equipment slot
|
||||
- **Real-time Preview** - Click any item to instantly apply it to your character via Glamourer
|
||||
- **Dye System** - Full dye/stain control with color previews and search functionality for each equipment slot
|
||||
- **Glasses Support** - Browse and apply bonus items (glasses/facewear) with proper icon display
|
||||
- **Search & Filter** - Quickly find items with the built-in search that persists across category tabs
|
||||
- **Allagan Tools Integration** - View detailed item information and locations directly from the browser
|
||||
- **Gear Set Management** - Apply complete sets of equipment with dyes in one click
|
||||
|
||||
## Requirements
|
||||
|
||||
- **Glamourer** - Required for applying equipment changes to your character
|
||||
- **Allagan Tools** (Optional) - Enhances the experience with item location lookup
|
||||
|
||||
## Installing
|
||||
|
||||
GlamourBrowser can be installed through a custom Dalamud repository:
|
||||
|
||||
1. Open Dalamud Settings in-game with `/xlsettings`
|
||||
2. Go to "Experimental" tab
|
||||
3. Add the following custom repository URL:
|
||||
```
|
||||
https://gitea.lozy.pink/lozy360/DalamudPluginRepo/raw/branch/main/custom.json
|
||||
```
|
||||
4. Click the "+" button to save
|
||||
5. Open the Plugin Installer and search for "GlamourBrowser"
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Operation
|
||||
|
||||
1. Open the plugin with `/gbrowser` or through the plugin menu
|
||||
2. Use the category tabs (Head, Body, Gloves, Legs, Feet, Glasses) to browse items
|
||||
3. Click any item to instantly apply it to your character
|
||||
4. Right-click items in the "Selected Gear" panel to remove them
|
||||
|
||||
### Dye Customization
|
||||
|
||||
- Each equipment slot in "Selected Gear" shows two dye dropdowns
|
||||
- Click a dye dropdown to see color previews and search for specific dyes
|
||||
- Right-click a dye to remove it
|
||||
- Dyes are applied automatically when you change them
|
||||
|
||||
### Search & Filtering
|
||||
|
||||
- Use the search bar at the top to filter items by name
|
||||
- The filter persists independently for each category tab
|
||||
- Works for both regular equipment and glasses
|
||||
|
||||
## Credits
|
||||
|
||||
- **Glamourer** - For providing the API that makes equipment preview possible
|
||||
- **Allagan Tools** - For item information and location lookup integration
|
||||
- **Dalamud & XIVLauncher** - For the plugin framework
|
||||
Reference in New Issue
Block a user