AGIDMGen

Anime Game Identity Mod Generator (AGIDMGen)

Makes identity mods: a mod of a character that looks exactly like the character already does in the game.

An identity mod changes nothing you can see. It is the character's own model, textures and colours, written out as a mod folder. That makes it the perfect starting point for making your own mod, or for checking that a mod loader works.

A sub-project of Anime Game Remap (AG Remap).

Contributors

Albert Gold (Active Lead Maintainer)
(Maintainer Team)

Requirements

• Python (version 3.9 and up)
  • When installing Python, tick the box "Add python.exe to PATH" at the bottom of the first screen.
• An internet connection (the character's files are downloaded for you)

Supported Games

[!TIP] Just want the mod? Every character's identity mod is already made for you in the Mods folder. That page also lists every character's name you can type below.

How to Run

• Choose your pick of which way to run it:

  • Choice A:   Quickstart! 🟢    (for beginners)
  • Choice B:   CMD WITHOUT a Script 🟡    (recommended if you run by CMD)
  • Choice C:   CMD with a Script 🟡    (the convention that other GIMI scripts follow)
  • Choice D:   API 🟠    (for expert coders)

Choice A: Let's Start ! 🟢

STEP 1:

• Right-click AGIDMGen.py, choose "Save link as...", and save the script into GIMI's or WWMI's Mods folder.

STEP 2:

• Double click on the script, and answer its two questions:

  • Which game? Type gimi for GI or wwmi for WuWa, then enter
  • Which characters? Type the character's name (eg. Yelan), then enter. For several characters, put a space between their names. For every character, type all.

• A new folder with the character's name (eg. Yelan) appears beside the script, holding the mod. When the script says == Press ENTER to exit ==, press enter.

[!TIP] Copy the character's name as it is written in the Mods list. The new folder is named exactly as you typed it.

[!NOTE] The first run installs what the script needs (numpy, and AG Remap's API), so it takes a little longer. Later runs skip that.

STEP 3:

• Open the game and enjoy it

Choice B: Run on CMD Without a Script 🟡

STEP 1:

• Install the generator onto your computer by opening cmd and typing:

python -m pip install -U AGIDMGen

then enter

( you can now run the program anywhere without copying a script! )

STEP 2:

• open cmd in GIMI's or WWMI's Mods folder and type the game's word, the character's name, then --download:

python -m AGIDMGen gimi Yelan --download

then enter

( or type only python -m AGIDMGen, and it asks you, as in Choice A )

STEP 3:

• Open the game and enjoy it

Choice C: Run on CMD With a Script 🟡

STEP 1:

• Get the script, as in Choice A's STEP 1

STEP 2:

• open cmd in that Mods folder and type python AGIDMGen.py, the game's word, the character's name, then --download.

  eg. for Yelan in GI:

python AGIDMGen.py gimi Yelan --download

then enter

eg. for Sanhua in WuWa:

python AGIDMGen.py wwmi Sanhua --download

[!TIP]

• Want several characters? Put a space between their names: python AGIDMGen.py gimi Yelan YelanTranquil --download
• Want every character? Use --all instead of a name: python AGIDMGen.py gimi --download --all
• Already have GI-Model-Importer-Assets or WWMI-Assets? Give the full path to the character's folder instead of its name, without --download: python AGIDMGen.py gimi "C:\path\to\GI-Model-Importer-Assets\PlayerCharacterData\Yelan"

STEP 3:

• Open the game and enjoy it

Choice D: API Usage 🟠

Tool developers can make identity mods within their own code!

API Setup

Make sure you first install the module by typing into cmd:

python -m pip install -U AGIDMGen

API Example

import AGIDMGen as IDMG
import FixRaidenBoss2 as FRB          # AG Remap's API: its logger works for both libraries

service = IDMG.IDModGenService(IDMG.ModLoaders.GIMI, names = ["Yelan", "YelanTranquil"], outputFolder = "Mods", logger = FRB.Logger())
service.generate()

print("Made:", sorted(service.stats.generated))

IDModGenService makes each mod into <outputFolder>/<name>, from download folders (names = [...]) or from asset folders (assetsFolders = [...]). A character that fails does not stop the others: it is recorded in service.stats, and nothing is printed unless you give it a logger.

class ForwardingLogger(FRB.BaseLogger):
    def write(self, message: str):
        send_to_frontend(message)          # eg. a websocket, a queue, a database row

    def read(self, desc: str) -> str:
        return ""                          # nothing interactive on a server

logger = FRB.Logger(logTxt = True, verbose = False)     # or: ForwardingLogger()
service = IDMG.IDModGenService(IDMG.ModLoaders.GIMI, names = ["Yelan"], outputFolder = folder, logger = logger)
service.generate()
transcript = logger.loggedTxt

service = IDMG.IDModGenService(IDMG.ModLoaders.WWMI, assetsFolders = ["WWMI-Assets/PlayerCharacterData/Sanhua"], outputFolder = "Mods")
service.generate()

mod = IDMG.GIMIIdentityModGenerator().generate("GI-Model-Importer-Assets/PlayerCharacterData/Yelan", "Mods/Yelan")
mod = IDMG.WWMIIdentityModGenerator().generateFromRepo("Sanhua", "Mods/Sanhua", version = "2.5")
print("\n".join(mod.getSummary()))

Command Options

Add these after the character's name. The Game column says which game has the option.

[!NOTE] The command ends with exit code 0 when every mod was made, 1 when one could not be (or the options are not valid), and 2 when a WWMI mod's shape keys do not match its Metadata.json.