Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 3.57 KB

readme.md

File metadata and controls

71 lines (45 loc) · 3.57 KB
Raw

VTTA Iconizer

Iconizer watches the creation of items in your world, and tries to find a suitable icon from a pre-populated name/icon dictionary. All you need to do, is

  • downloading a suitable icon library, or use the icons that are coming with Foundry
  • creating a dictionary
  • create items and watch the magic happen

Pre-requisites

Disclaimer: I strongly advise to use icons that you have actually licensed, and urge you not to redistribute any icons that you are not allowed to redistribute.

Having icons is a must. You can use the icons that are coming with Foundry, get other icons using the Unity Asset Store or watch the Humble Bundle for suitable packages.

What I did, and what the default database references are the icons from the game World of Warcraft, which I played close to 12 years. You can download icon sets on sites like wowinterface.com, including a tool that converts the internally used BLP format to PNG:

Download one of the icon sets from wowinterface.com, unzip them into a directory and convert the BLP files into PNG files. Copy or move those PNG icons directly into the configure icon directory (see below).

Alternatively, you can create a custom database using icons of your choice, please see the custom database format and file location below.

Note that you can still overwrite your custom items with a dictionary that you create (see below). Your user-defined dictionary takes precedence over the DDB Bridge one.

Configuration

Icon replacement policy

Three settings are available:

  • Replace all icons - All icons are replaced by an entry in the icon database. If there isn't an entry for this item in the database, the default icon (mystery man) will be used instead
  • Replace only default icons - The icon will be replaced only if the current icon is the default icon (mystery man)
  • Do not replace any icons - No icons will be replaced. You better uninstall this module ;)

Icon database policy

Defines which databases are queried when selecting an icon. You can choose between using the pre-defined database only, using your custom database only or using both at the same time. When using both databases, entries in your custom database take precedence, allowing you to overwrite entries in the predefined database

Icon directory

Sets the icon directory where you are storing your icons. It is relative to the Foundry /Data directory, please do not add a leading or trailing slash to this path.

Examples:

  • img/icons references to [Foundry]/Data/img/icons
  • icons references to [Foundry]/Data/icons
  • `` references to [Foundry]/Data - probably not recommended

Creating a custom database

Create a file called icons.json in the icon directory and adjust the Icon database policy to use your new database exclusively or additionally to the default database.

The file format is as follows:

[
    {
        "name":"Mace, +3",
        "icon":"INV_Mace_2h_DraenorCrafted_D_01_C_Horde.png"
    },
    {
        "name":"Flame Tongue Longsword",
        "icon":"inv_sword_1h_artifactfelomelorn_d_02.png"
    }
]

The lookup is based on a name referencing an icon. The matches are made case-insensitive.

Just add all the entries you want to change, save the file and reload your world. The entries in your user-defined file have priority and will overwrite everything in the base directory.