🐉 Realms of the Dragon GUI for Mudlet
---------------------------------------
Welcome, Adventurer!

This GUI was created to enhance your experience in Realms of the Dragon with graphics and dynamic NPC/Friend tracking. Whether you're a seasoned dragon-slayer or a Realms of the Dragon newbie, I hope this package will help you on your journey.

IMPORTANT: IF YOU ARE UPDATING THIS PACKAGE: First save a copy of your custom Avatar_Player images and custom Friends images and your and map updates to ROTDMapData.dat file to your Desktop to avoid them being over-written!!!

To use this Graphical User Interface you will need:
- Mudlet - You can download Mudlet for Windows, macOS, or Linux at mudlet.org/download and install it by running the appropriate installer for your system.
- Realms of the Dragon Mud Player Character: Host: mud.rod.org or 45.79.146.131 / Port: 3000
- Mudlet ROTD_GUI Package


📜 Getting Started with a Few Easy Steps
-----------------------------------------
Getting started — simple steps
- Download the package file (ROTD_GUI.pkg).
- Connect to Realms of the Dragon mud
- Open Mudlet and go to the Package Manager (or choose Import package from the main menu).
- Import the package Package Manager > Install Package > Navigate to downloaded package > highlight > Open and confirm installation.
- Close and re-open your Mudlet profile for Realms of the Dragon and load the ROTD_GUI package.
- Right click on your ROTD button icon > set custom icon > navigate to profiles/<Mudlet Realms of the Dragon directory>/ROTD_GUI/Button/ > Click on Button image
- Log in to your Realms of the Dragon mud in Mudlet. 
Note: Please allow a few minutes once you load Realms of the Dragon mud for the images to refresh.
- After logging in verbose mode:
- Type score and press Enter to update your max score.
- Type i and press Enter to update your inventory display; repeat i if room text appears instead of inventory once you have the inventory.

Quick and Easy Mudlet Mapping
-----------------------------
- Click the globe Map icon to view maps
- If the map does not load, type realms load to load Telepati's maps
- To move the map to your location type glance and then type teleport to update the map to your location.
Note: If the map still cannot find you try again by moving to a different room and type glance and teleport.
- If you make any map changes type realms save to update your copy of the maps.


Getting Started - Updating Images:
----------------------------------
- Copy your avatar images to: profiles/<Mudlet Realms of the Dragon directory>/ROTD_GUI/ (use filenames and overwrite avatar_player1.png → avatar_player10.png).
- Add NPC portraits to: profiles/<Mudlet Realms of the Dragon directory>/ROTD_GUI/NPC/ using lowercase_with_underscores and 150×225 PNG images.
- Add friend portraits to: profiles/<Mudlet Realms of the Dragon directory>/ROTD_GUI/Friend/ using the same format and size.

📜 FAQ & Setup Guide
---------------------
1. How do I update my avatar images?
- Navigate to your Mudlet directory:
profiles/ROD /ROTD_GUI/
- Inside, you'll find 10 avatar slots:
avatar_player1.png through avatar_player10.png
- Keep the names the same and replace these files with your own character portraits.
- Close Mudlet and re-open then click the “Change” button beneath your avatar to cycle through your new images.

2. What format and size should my images be?
- Format: PNG (.png)
- Dimensions: 150 × 225 pixels
- Framing: Head-to-knee recommended for consistency

3. How can I add or replace NPC images?
- Place NPC images in: Mudlet directory profiles/ROD/ROTD_GUI/NPC/
- Filenames must match NPC names or keywords found in game text.
Example: Eluten_Guard.png matches “Eluten Guard” in combat or room descriptions.
- Format: PNG (.png)
- Dimensions: 150 × 225 pixels
- Naming: For best GUI recognition, be sure to use the same capitalization and underscores for spaces (e.g., Red_Dragon.png)
- The GUI auto-scans this folder and updates portraits dynamically.
TIP: If an NPC portrait doesn’t appear, check for exact name matches, rename and click the “Update” button to refresh the registry.

4. How do I add or edit friend portraits?
- Place friend images in: Mudlet directory profiles/ROD/ROTD_GUI/Friend/
- Format: PNG (.png)
- Dimensions: 150 × 225 pixels
- The GUI matches friend names from tells, greetings, or login messages.
- Click “Edit Notes” to open the notes file in your system editor.
- The "Default" is the first friend image you will see otherwise in friend_notes.txt the first Friend listed will show up when you update the registry
⚠️ Avoid adding your Player avatar name picture to the Friend folder or name to friend_notes.txt, as this will cause the GUI to constantly refresh your own image or notes as you are playing.

5. How do I update my max score?
- Change to verbose mode if you are in brief mode
- Type score and press Enter.
- Your score will also update during battles.

6. How do I update my inventory?
- After logging in to the mud, type i and press Enter to refresh your inventory (holding, wearing, carrying, coins).
- If the GUI displays room text instead of inventory, type i again once items are present.

7. Can I customize the GUI layout or colors?
- Yes! All GUI elements are modular and styled via Geyser labels.
- Edit ROTD_GUI.lua to adjust colors, fonts, or positioning.
- Always back up your script before making changes.

8. What are the map commands again?
- realms load = Loads Telepati's maps for Realms of the Dragon
- glance = shows the brief description of the room if you are in verbose mode
- teleport = moves the map to the current position based on the brief description and exit(s) match
- realms save = save any changes you made to the map
⚠️ If the map cannot find you try moving around and repeating glance > teleport commands
- map help = lists all of the default Mudlet commands for your mapping enjoyment
- realms save = saves any map changes that you made to ROTDMapData.dat file

🛠 Troubleshooting
------------------
- ✅ Confirm filenames match NPC name or friend names.
- ✅ Ensure images are .png and sized 150 × 225.
- ✅ Use same capitalization and underscores for consistency.
- ✅ Click “Update” to refresh NPC or Friend registry.
- ✅ Verbose mode is preferred and needed for “Score” updates.
- ✅ realms load to load the ROTDMapData.dat file.
- ✅ glance then teleport to update the map to your current location, if needed move and try again


🗂 Project Structure
- ROTD_GUI.xml – Main layout
- ROTD_GUI.lua – Core logic
- ROTD_Portraits.lua, ROTD_Inventory.lua, etc. – Modular files
- Rod_Map - Mapper logic by Telepati
- ROTDMap.dat - Realms of the Dragons Maps by Telepati

📦 Packaging & Publishing
- Includes:
- Setup guide
- Trigger lists
- Customization tips
- Screenshots and player sample portraits, friend portraits and notes, NPC portraits
- Maps by Telepati

🧙 Credits & Lore

Maps and Map scripts by Telepati, Dragon Templar: https://rod.drugges.se/lore/63209d9afc375519341304e9
Co-created by Adventurer1111 and AI(CoPilot) through prompt-driven sessions.
Design, implementation, art direction, and testing, coding by Adventurer1111.
Provenance and co-authorship documented for transparency and open-source ethics.

🌟 May your path be clear, your companions loyal, and your rituals ever radiant. 🌟



