[6.x] AsymEyes For Everyone

spiswel (myself) - AsymFaces, AsymEyes frameworks building, guide-writing, assets-making, crying a lot
Nylfae - Atramentum Luminis, shader reverse-engineering research, assets-making, scripting help, explaining all the details to Spis like he’s 5

(!!) THIS FRAMEWORK DOES NOT CONTAIN ANY ASYM MODDED EYE TEXTURES BY DEFAULT,
GO CREATE YOUR OWN USING THE DOCUMENTATION HELP PROVIDED IN THE FILES TAB.
Placeholder Vanilla Asym textures are provided for QOL & debugging.

THIS MOD WAS MADE PRIOR TO THE RELEASE OF PATCH 7.0 DAWNTRAIL AND MAY NOT WORK PROPERLY AS OF JUNE 28 2024. UPDATES ARE PENDING

Due to human lifetime limitations, it is impossible for this framework to auto-customize your character's eyes using the specific eye mods you use for you.
You WILL have to go edit your own textures using your favorite eye mods of choice.
Go DIY yourself some amazing eyes.

--- ATRAMENTUM LUMINIS v3.0.0 OR ABOVE IS REQUIRED FOR THIS FRAMEWORK TO FUNCTION ---
https://www.xivmodarchive.com/modid/68013

-----------------
ASYMEYES GENERAL PERMISSIONS
-----------------

DO: ✅

- edit/create/release new textures or models based on the AsymEyes layout
- respect creators' permissions before porting their textures to AsymEyes
- use AsymEyes in private/paid commissions

DONT: ⛔

- resell, redistribute or claim any parts of these frameworks as your own

Additionally, the original permissions for Atramentum Luminis (listed as follows) must be followed:

You may mostly do what you want with this framework, but you may not charge for it. If you charge for a bundle that includes it, you must make it available separately for free. This framework also comes as-is, without warranty of any kind.

Please contact me on Discord if there's any doubt about permissions.

--- general info ---

AsymEyes is a new-gen framework mod allowing the usage of asymmetrical eye textures with glow-support even on symmetrical, vanilla faces.

This framework is entirely separate from the existing AsymFaces frameworks.
However the author highly recommends them for further asymmetrical facial textures customization, especially for users who wish to use teeth replacements such as IllyBites/LorFangs : https://www.xivmodarchive.com/modid/31453

--- AsymEyes Custom Texture Pathing ---

The AsymEyes framework edits the vanilla eye material (IRI_A) to implement a custom texture folder (chara/asymeyes/).
This allows us to have unique texture paths for each race/clan/gender/facetype number, with no more "sharing" needed between the clans.
It also allows us to use a logical, singular pathing convention for every texture in the material across the entire framework to simplify usage and help with QOL.

This core path is as follows :
- chara/asymeyes/RACE_CLAN_GENDER/FACE_TEXTYPE.tex

Note every component is in lowercase letters, no special characters like hyphens or apostrophes, and no spaces in any of them in the entire path.

Explanations on each component :

[RACE] = race shorthand identifier, listed below
- hyur
- elezen
- miqote
- roegadyn
- lalafell
- aura
- hrothgar
- viera

[CLAN] = clan shorthand identifier from the list of races above, listed below
- midlander / highlander
- wildwood / duskwight
- seeker / keeper
- seawolf / hellsguard
- plainsfolk / dunesfolk
- raen / xaela
- helion / thelost
- rava / veena

[GENDER] = character model's gender
- male / female

[FACE] = lowercase 'f', standing for 'face', followed by the character's clan & facetype number identifier as follows :
- f001 - f004 = first clan (listed in the clans' list above)
- f101 - f104 = second clan (listed in the clans' list above)
ABOUT HROTHGAR MALES : the materials' numbering go from 005-008 and 105-108 in the vanilla files, however this framework respects the 001-004 and 101-104 convention for them still out of QOL concerns.
Additionally, while most clans only posess 4 facetypes each, Hyur Midlanders go up to 007 for Males and 005 for Females respectively.

[TEXTYPE] = type of texture, identified between
_normal - normal map (surface depth of the eye)
_multi - multi/specular map (eye texture) - note this is what the majority of eye texture mods replace
_catchlight - catchlight map (shape of the light reflections)

--- credits ---

This framework was brought to you by 2 French nerds

--- changelog ---

v 1.0.1 - fixed Miqo'te Keeper M F103+F104 paths partially directing to Keeper M F102

v 1.0.0 - initial public release