#!/usr/bin/env python3 """The unit datasheet's own schema, as shipped on the disc. Each GP_MAIN_GAME_*.pak carries 15 IDXD records whose field VALUES are Japanese type names rather than data -- Shift-JIS, and the only non-ASCII strings on the whole disc. Records whose name ends '_???' (and 'NS_*') are wildcards standing for the numbered family, e.g. Turret_??? for Turret_000..Turret_00N. Where a field's type is an enumeration the schema holds an EXAMPLE value instead of a type name ('Yes' for a boolean, 'Vessel' for Generic.Type). Regenerates docs/re/data/datasheet-schema.txt. """ import glob, os, sys from disc import disc_root sys.path.insert(0, os.path.dirname(os.path.abspath(__file__))) from unit_substructures import pak_entries import unitgroup as U # the six type names, held as latin-1 (how unitgroup.py hands strings back) TYPES = { '\x95\xb6\x8e\x9a\x97\xf1': 'STRING', 'NS_"\x95\xb6\x8e\x9a\x97\xf1"': 'NS_STRING', '\x90\xae\x90\x94': 'INT', '\x90\xae\x90\x94\x92l': 'INT_VALUE', '\x95\x82\x93\xae\x8f\xac\x90\x94\x92l': 'FLOAT', '\x95\x82\x93\xae\x8f\xac\x90\x94\x92l[0\x81`1]': 'FLOAT[0..1]', } def main(): pak = sorted(glob.glob(disc_root() + '/**/GP_MAIN_GAME_D.pak', recursive=True)) if not pak: print('disc not mounted; nothing to do'); return out = {} for h, b in pak_entries(pak[0]): if b[:4] != b'IDXD': continue try: recs = U.parse(b) except Exception: continue for r in recs: if any(v in TYPES for t, f, v in r['fields']): out[r['squadron']] = r['fields'] print('the unit datasheet schema shipped in GP_MAIN_GAME_*.pak') print('%d schema records; identical in all six paks (x6 = one user)' % len(out)) print() for name in sorted(out): fields = out[name] typed = sum(1 for t, f, v in fields if v in TYPES) print('=== %s (%d fields, %d typed) ===' % (name, len(fields), typed)) for t, f, v in sorted(fields, key=lambda x: (x[1] or '')): print(' %-28s %s' % (f, TYPES.get(v, 'example: ' + repr(v)))) print() if __name__ == '__main__': main()