Files
the-nexus-fork/nexus/evennia_mempalace/__init__.py

50 lines
1.5 KiB
Python

"""nexus.evennia_mempalace — Evennia plugin for MemPalace fleet memory.
This contrib module provides:
Commands (add to ``settings.CMDSETS_DEFAULT`` or a CmdSet):
CmdRecall — ``recall <query>`` / ``recall <query> --fleet``
CmdEnterRoom — ``enter room <topic>`` teleports to a palace room
CmdRecord — ``record decision <text>`` writes to hall_facts
CmdNote — ``note breakthrough <text>`` writes to hall_discoveries
CmdEvent — ``event <text>`` writes to hall_events
Typeclasses (use in place of Evennia's default Room/Character):
MemPalaceRoom — Room whose description auto-populates from palace search
StewardNPC — Wizard steward that answers questions via palace search
Usage example (in your Evennia game's ``mygame/server/conf/settings.py``)::
MEMPALACE_PATH = "/root/wizards/bezalel/.mempalace/palace"
MEMPALACE_WING = "bezalel"
FLEET_PALACE_PATH = "/var/lib/mempalace/fleet"
Then import commands into a CmdSet::
from nexus.evennia_mempalace.commands import (
CmdRecall, CmdEnterRoom, CmdRecord, CmdNote, CmdEvent
)
"""
from __future__ import annotations
from nexus.evennia_mempalace.commands import (
CmdEnterRoom,
CmdEvent,
CmdNote,
CmdRecord,
CmdRecall,
)
from nexus.evennia_mempalace.typeclasses.rooms import MemPalaceRoom
from nexus.evennia_mempalace.typeclasses.npcs import StewardNPC
__all__ = [
"CmdRecall",
"CmdEnterRoom",
"CmdRecord",
"CmdNote",
"CmdEvent",
"MemPalaceRoom",
"StewardNPC",
]