Skip to content

Character Registry API

Character Registry API Reference

CHARACTER_REGISTRY maps character IDs to their CharacterClass definitions.

Module Location

from skeletons.character_classes.characters import CHARACTER_REGISTRY

Registry Structure

CHARACTER_REGISTRY: Dict[str, Type[CharacterClass]]

Keys: Character IDs saved in settings

Values: CharacterClass subclasses

Built-in Characters

IDClassDisplay NameNotes
character1CharacterOneChatLinkDefault character
character2CharacterTwoDinoCustom collider size
character3CharacterThreeCKghnitLarge scale sprite

Usage Example

from skeletons.character_classes.characters import CHARACTER_REGISTRY
character_cls = CHARACTER_REGISTRY["character1"]
character = character_cls().build(pygame.Vector2(100, 100))

Adding New Characters

Register new characters by adding them to CHARACTER_REGISTRY:

CHARACTER_REGISTRY["robot"] = RobotCharacter