API Hero list_characters

gm.hero.list_characters

Endpoint: gm.hero.list_characters

Syntax

gm.hero.list_characters

Parameters

This command takes no parameters.

Description

Lists all saved character set files in the BLGM character sets directory. Character set files are JSON files created by gm.hero.export_character and can be loaded onto existing heroes using gm.hero.load_character or used to spawn a new hero via gm.hero.import_character.

A character set is a complete snapshot of a hero including appearance, development (skills, attributes, perks), traits, battle equipment, and civilian equipment. Use this command to see which character presets are available.

Examples

List All Character Set Files

gm.hero.list_characters

Output (files found):

Saved Character Set Files:
  Found 3 file(s):

  1. my_king.json
  2. ira_backup.json
  3. king_export.json

Output (no files):

Saved Character Set Files:
  (No saved character set files found)
  Directory: C:\...\BLGM\CharacterSets\

Usage Tips

Workflow - Export then List:

# Export a hero's full character data
gm.hero.export_character derthert my_king

# Verify it was saved
gm.hero.list_characters

# Load onto an existing hero
gm.hero.load_character 'Ira of the Aserai' my_king

# Or import as a brand new hero
gm.hero.import_character my_king 'dey meroc' lord

File Location: Character set files are stored in the BLGM data directory under a CharacterSets subfolder. The exact path is shown when no files are found.

Related Commands

• gm.hero.export_character - Export a hero's full character data to a file
• gm.hero.load_character - Load a character set onto an existing hero
• gm.hero.import_character - Create a new hero from a character set file
• API-Hero-Overview - All hero commands

Notes

No Arguments Required: This command requires no arguments and displays the directory listing immediately.

File Format: Saved character set files use the .json extension and contain the complete hero snapshot including appearance, development, traits, and equipment.

Campaign Required: A campaign must be active before this command can be used.

Last Updated: 3/3/2026