Skip to content

SirMotte/FGU-GM-Icon-Replacer

Repository files navigation

FGU-Theme-GM-Icon-Replacer

A Fantasy Grounds Unity Extension.

This extension enables the user to exchange their GM Icon with a custom image asset.

In order to do so, you must open up the extension file and replace the GM_Icon.png withing the PNGs folder with your custom asset. Keep in mind, that the asset you choose is best used with a resolution not larger than 42x42px. I recommend using 32x32px if you're using my Dark Theme. If you would like to use the golden frame that the standard icon uses in my Hearth Theme, I've included templates for you to make use of within your favourite image editing software.

Installation & Customization

If you're not using advanced file managers like Total Commander or Directory Opus, that handle opening up zipped files on the fly, you will need to follow these steps, otherwise only follow step 4,5,6 and 10,11:

  1. Rename the GM_Icon_Replacer.ext to GM_Icon_Replacer.zip.
  2. Unpack the zip file with a zip handler of your choice like winrar or 7zip.
  3. Open up the unpacked folder. There you will find xml files and two folders.
  4. If you want to, navigate to the templates folder and use the provided graphics and .svgs to create your own GM Icon on top.
  5. Otherwise use whatever icon you like and rename it to GM_Icon.png and place it into the PNGs Folder. (Keep in mind the resolution mentioned above).
  6. When asked to overwrite, click yes.
  7. Repack the GM_Icon_Replacer Folder again to GM_Icon_Replacer.zip.
  8. Rename the GM_Icon_Replacer.zip file to GM_Icon_Replacer.ext again.
  9. Move the file named "GM_Icon_Replacer.ext" into the "Extensions" Folder found inside your Fantasy Grounds "Data" folder.
  10. Activate the Extension listed as "Theme: GM Icon Replacer" in your campaign details page in the "Extensions" section and launch the campaign.
  11. Done, I hope you like it!

Advanced customization

In case you want to make the extension file unique, to e.g. have several options to choose from when launching your campaign, follow these steps:

  1. Rename the GM_Icon_Replacer.ext file to something unique, for example GM_Icon_Replacer_YourName.ext.
  2. Within the .ext file, open up the extension.xml with a text editor of your choice.
  3. Modify this line <name>Theme: GM Icon Replacer</name> to, for example <name>Theme: GM Icon Replacer - YourName</name>
    • This will make sure, that if more than one Replacer Extension is present, Fantasy Grounds can pick up on this and show them as different extensions. Otherwise only the last one loaded will shop up.

If you want to include additional icon replacements, you can add them to the override.xml.

Enjoy! Sir Motte

About

This small add on enables the user to exchange their GM Icon within Fantasy grounds Unity with a custom graphic.

Resources

License

Stars

Watchers

Forks

Packages

No packages published