4everCraft Mod/com.evermod.lorekeeper/LoreStorage

LoreStorage

Persistent storage for lore entries and weekly news snapshots.

This class extends Minecraft's SavedData to automatically persist lore entries to the world save. It maintains weekly snapshots for the Lorekeeper Gazette and submitted-book inventory.

Usage

val storage = LoreStorage.get(server)
storage.addEntry(LoreEntry("Player built a castle", "Steve", System.currentTimeMillis()))

Constructors

LoreStorage

constructor()

Types

Companion

object Companion

Companion object containing constants and factory methods.

LoreEntry

data class LoreEntry(val text: String, val author: String, val timestamp: Long, val notionId: String = "", val notionLastEdited: Long = 0, val qualityScore: Int = 0, val qualityTags: List<String> = emptyList(), val qualitySummary: String = "")

A single lore entry recording an event or player contribution.

MemoryRecord

data class MemoryRecord(val recordId: String, val source: String, val sourceRef: String, val timestamp: Long, val text: String, val tags: List<String> = emptyList(), val names: List<String> = emptyList(), val subjects: List<String> = emptyList())

Canonical interpreted memory record used for retrieval-oriented AI context assembly.

ReputationMemoryEvent

data class ReputationMemoryEvent(val playerId: String, val playerName: String, val timestamp: Long, val source: String, val delta: Int, val reason: String, val evidence: String = "", val relatedNames: List<String> = emptyList())

A structured event describing why reputation changed or what context was observed.

ReputationProfile

data class ReputationProfile(val playerId: String, val playerName: String, val alignment: String, val score: Int, val tier: String, val timestamp: Long, val summary: String, val trigger: String)

An archived hero/villain profile generated for a player.

SubmittedBook

data class SubmittedBook(val title: String, val author: String, val content: String, val submittedBy: String, val submittedById: String = "", val timestamp: Long, val qualityScore: Int = 0)

A player-submitted written book preserved for future sale by the Lorekeeper.

WeeklyNews

data class WeeklyNews(val week: Long, val entries: List<LoreStorage.LoreEntry>)

A snapshot of lore entries for a specific in-game week.

WeeklySummary

data class WeeklySummary(val week: Long, val summary: String)

AI-generated summary for a specific week.

Properties

isDirty

open var isDirty: Boolean

Functions

addEntry

fun addEntry(entry: LoreStorage.LoreEntry)

Adds a single lore entry to storage.

addEntryText

fun addEntryText(text: String, author: String, timestamp: Long)

Convenience method to add a lore entry from raw values.

addEntryTextChunked

fun addEntryTextChunked(text: String, author: String, timestamp: Long, maxChunkLength: Int)

Adds a long text as multiple chunked entries.

addEntryTextChunkedWithResult

fun addEntryTextChunkedWithResult(text: String, author: String, timestamp: Long, maxChunkLength: Int): List<LoreStorage.LoreEntry>

Adds a long text as multiple chunked entries and returns the created entries.

addEntryTextWithResult

fun addEntryTextWithResult(text: String, author: String, timestamp: Long): LoreStorage.LoreEntry

Adds a lore entry and returns the created entry.

addReputationEvent

fun addReputationEvent(event: LoreStorage.ReputationMemoryEvent, maxEventsPerPlayer: Int = 200)

Records a reputation memory event for later profile generation and narrative grounding.

addReputationProfile

fun addReputationProfile(profile: LoreStorage.ReputationProfile, maxProfilesPerPlayer: Int = 1)

Stores the active archived reputation profile for a player.

addSubmittedBook

fun addSubmittedBook(submission: LoreStorage.SubmittedBook): LoreStorage.SubmittedBook?

Stores an accepted player-submitted book for Lorekeeper resale.

attachNotionMetadata

fun attachNotionMetadata(text: String, author: String, timestamp: Long, notionId: String, notionLastEdited: Long): Boolean

Updates a local entry with Notion metadata after creating a page.

clearAll

fun clearAll()

Clears all entries and snapshots.

clearNewsSnapshot

fun clearNewsSnapshot(week: Long)

Clears the news snapshot and AI summary for the given week.

findSubmittedBook

fun findSubmittedBook(title: String, author: String, submittedById: String, timestamp: Long): LoreStorage.SubmittedBook?

Finds a submitted book by stable identifiers for resale-volume delivery.

getAiHistoryEdition

fun getAiHistoryEdition(): Int

Returns the published edition number of the history book.

getAiHistorySummary

fun getAiHistorySummary(): String

Returns the AI-generated history summary, or empty string if none exists.

getAiHistoryTimestamp

fun getAiHistoryTimestamp(): Long

Returns the timestamp when the AI history summary was last generated.

getAiNewsSummary

fun getAiNewsSummary(week: Long): String?

Returns the AI-generated summary for the given week, or null if none exists.

getAllAiNewsSummaries

fun getAllAiNewsSummaries(): List<LoreStorage.WeeklySummary>

Returns all stored AI weekly summaries (one per week).

getAllEntries

fun getAllEntries(): List<LoreStorage.LoreEntry>

Returns a copy of all stored entries in chronological order.

getAllMemoryRecords

fun getAllMemoryRecords(): List<LoreStorage.MemoryRecord>

Returns all canonical memory records sorted oldest-to-newest by timestamp.

getAllReputationEvents

fun getAllReputationEvents(): List<LoreStorage.ReputationMemoryEvent>

Returns all recorded reputation memory events.

getAllReputationProfiles

fun getAllReputationProfiles(): List<LoreStorage.ReputationProfile>

Returns all archived reputation profiles.

getEntryCount

fun getEntryCount(): Int

Returns the current number of stored entries.

getLatestEntries

fun getLatestEntries(limit: Int): List<LoreStorage.LoreEntry>

Returns the most recent entries up to the specified limit.

getLatestEntryTimestamp

fun getLatestEntryTimestamp(): Long

Returns the timestamp of the most recent entry, or 0 if no entries exist.

getLatestMemoryRecords

fun getLatestMemoryRecords(limit: Int): List<LoreStorage.MemoryRecord>

Returns latest canonical memory records in chronological order.

getLatestReputationProfile

fun getLatestReputationProfile(playerId: String): LoreStorage.ReputationProfile?

Returns the latest archived reputation profile for a player.

getLatestSubmittedBooks

fun getLatestSubmittedBooks(limit: Int): List<LoreStorage.SubmittedBook>

Returns the most recent submitted books up to the specified limit.

getMemoryBackfillVersion

fun getMemoryBackfillVersion(): Int

Returns completed memory-index backfill version for this world.

getMemoryRecordCount

fun getMemoryRecordCount(): Int

Returns current canonical memory record count.

getNewsSnapshot

fun getNewsSnapshot(week: Long): List<LoreStorage.LoreEntry>?

Returns an existing news snapshot for the given week, or null if none exists.

getNotionLastSync

fun getNotionLastSync(): Long

Returns the last time Notion sync completed, or 0 if never synced.

getOrCreateNewsSnapshot

fun getOrCreateNewsSnapshot(week: Long, limit: Int): List<LoreStorage.LoreEntry>

Gets or creates a weekly news snapshot.

getPaginationRepublishVersion

fun getPaginationRepublishVersion(): Int

Returns the version of completed pagination republish backfills for this world.

getReputationEventsForPlayer

fun getReputationEventsForPlayer(playerId: String, limit: Int = Int.MAX_VALUE): List<LoreStorage.ReputationMemoryEvent>

Returns recent reputation memory events for the given player, newest-first.

getSubmittedBookCount

fun getSubmittedBookCount(): Int

Returns the current number of stored submitted books.

hasNewsSnapshot

fun hasNewsSnapshot(week: Long): Boolean

Returns true if a news snapshot exists for the given week.

markMemoryBackfillVersion

fun markMemoryBackfillVersion(version: Int)

Marks the memory-index backfill version when a migration run completes.

markPaginationRepublishVersion

fun markPaginationRepublishVersion(version: Int)

Marks the pagination republish backfill version when a one-time migration completes.

removeEntryAt

fun removeEntryAt(index: Int): LoreStorage.LoreEntry?

Removes an entry at the specified index.

removeMemoryRecords

fun removeMemoryRecords(source: String, sourceRef: String? = null): Int

Removes memory records by source and optional source reference.

setAiHistorySummary

fun setAiHistorySummary(summary: String, timestamp: Long)

Stores an AI-generated history summary with its generation timestamp.

setAiNewsSummary

fun setAiNewsSummary(week: Long, summary: String)

Stores an AI-generated summary for the given week.

setNotionLastSync

fun setNotionLastSync(timestamp: Long)

Updates the last Notion sync timestamp.

updateEntryQuality

fun updateEntryQuality(text: String, author: String, timestamp: Long, qualityScore: Int, qualityTags: List<String>, qualitySummary: String): Boolean

Updates quality metadata for a specific entry.

upsertMemoryRecord

fun upsertMemoryRecord(record: LoreStorage.MemoryRecord): Boolean

Upserts a canonical memory record by deterministic MemoryRecord.recordId.

upsertMemoryRecords

fun upsertMemoryRecords(records: List<LoreStorage.MemoryRecord>): Int

Upserts a batch of memory records and returns the number of changed rows.

upsertNotionEntry

fun upsertNotionEntry(notionId: String, text: String, author: String, timestamp: Long, notionLastEdited: Long): Boolean

Updates or inserts a lore entry based on Notion data.

LoreStorage

Usage

See also

Constructors

Types

Properties

Functions