メインコンテンツまでスキップ

Interface

Runtime configuration and metadata that xp exposes throughout simply-xp.

PropertyTypeOptionalDefaultDescription
auto_createboolean✅falseAllows helpers to create missing users when they are queried.
databaseMongoClient or Database✅undefinedUnderlying database connection provided by the consumer.
dbNamestring✅MongoDB only: explicit database name used for internal calls.
dbType"mongodb" | "sqlite"✅mongodbConfigured database provider.
debugboolean✅falseEmit debug logging via XpLog.debug.
notifyboolean✅trueEnable console notifications (on by default).
registeredFontsArray<string>✅[]Fonts already registered for rendering helpers.
versionstring✅2.0.0simply-xp version string baked into the package.
xp_ratenumber✅0.1Global XP rate used during XP ↔︎ level conversions.