New method for customizing the oracle tree

CHANGELOG.md

@@ -6,6 +6,7 @@
 - Fixed bug with Starforged asset decoration; it should now switch with the game theme as intended ([#700](https://github.com/ben/foundry-ironsworn/pull/700))
 - Drop the custom font ([#702](https://github.com/ben/foundry-ironsworn/pull/702))
 - Fix a tooltip bug on the edit-sector button
+- Added a new method of customizing oracles, which should work better for larger projects like Ironsmith ([#686](https://github.com/ben/foundry-ironsworn/pull/696))
 
 ## 1.20.30
 

src/config.ts

@@ -15,6 +15,10 @@ import { FirstStartDialog } from './module/applications/firstStartDialog'
 import { SFSettingTruthsDialogVue } from './module/applications/vueSfSettingTruthsDialog'
 import { WorldTruthsDialog } from './module/applications/worldTruthsDialog'
 import { OracleWindow } from './module/applications/oracle-window'
+import {
+	getOracleTree,
+	registerOracleTree
+} from './module/features/customoracles'
 
 export interface EmitterEvents extends Record<EventType, unknown> {
 	highlightMove: string // Foundry UUID
@@ -27,7 +31,6 @@ export type IronswornEmitter = Emitter<EmitterEvents>
 
 export interface IronswornConfig {
 	actorClass: typeof IronswornActor
-	importFromDatasworn: typeof importFromDatasworn
 
 	applications: {
 		// Dialogs
@@ -44,10 +47,15 @@ export interface IronswornConfig {
 		OracleRollMessage: typeof OracleRollMessage
 	}
 
+	importFromDatasworn: typeof importFromDatasworn
+
 	Dataforged: typeof starforged
 	dataforgedHelpers: typeof dataforgedHelpers
 
 	emitter: IronswornEmitter
+
+	registerOracleTree: typeof registerOracleTree
+	getOracleTree: typeof getOracleTree
 }
 
 export const IRONSWORN: IronswornConfig = {
@@ -71,5 +79,8 @@ export const IRONSWORN: IronswornConfig = {
 	Dataforged: starforged,
 	dataforgedHelpers,
 
-	emitter: Mitt<EmitterEvents>()
+	emitter: Mitt<EmitterEvents>(),
+
+	registerOracleTree,
+	getOracleTree
 }

src/index.ts

@@ -38,6 +38,7 @@ import { registerTours } from './module/features/tours'
 import { CompactPCSheet } from './module/actor/sheets/compact-pc-sheet'
 
 import 'virtual:svg-icons-register'
+import { registerDefaultOracleTrees } from './module/features/customoracles'
 
 declare global {
 	interface LenientGlobalVariableTypes {
@@ -228,11 +229,11 @@ Hooks.once('ready', async () => {
 
 	registerDragAndDropHooks()
 	registerChatAlertHooks()
-	runStartupMacro()
+
+	await registerDefaultOracleTrees()
 
 	await FirstStartDialog.maybeShow()
 	await registerTours()
 
-	// Pre-load all the oracles
-	await primeCommonPackCaches()
+	runStartupMacro()
 })

src/module/features/customoracles.ts

@@ -5,13 +5,13 @@ import type {
 	Ironsworn
 } from 'dataforged'
 import { starforged, ironsworn } from 'dataforged'
-import { compact } from 'lodash-es'
+import { cloneDeep, compact } from 'lodash-es'
 import { getFoundryTableByDfId } from '../dataforged'
 import { cachedDocumentsForPack } from './pack-cache'
 
 export interface IOracleTreeNode {
 	dataforgedNode?: IOracle | IOracleCategory
-	tables: Array<() => RollTable>
+	tables: string[] // UUIDs
 	displayName: string
 	children: IOracleTreeNode[]
 	forceExpanded?: boolean
@@ -26,12 +26,11 @@ const ISOracleCategories = ((ironsworn as any).default as Ironsworn)[
 	'Oracle Categories'
 ]
 
-const emptyNode = () =>
-	({
-		displayName: '',
-		tables: [],
-		children: []
-	} as IOracleTreeNode)
+const emptyNode: () => IOracleTreeNode = () => ({
+	displayName: '',
+	tables: [],
+	children: []
+})
 
 async function createOracleTree(
 	compendium: string,
@@ -47,23 +46,17 @@ async function createOracleTree(
 		rootNode.children.push(await walkOracleCategory(category))
 	}
 
-	// Add in custom oracles from a well-known directory
-	await augmentWithFolderContents(rootNode)
-
-	// Fire the hook and allow extensions to modify the tree
-	await Hooks.call('ironswornOracles', rootNode)
-
 	return rootNode
 }
 
-export async function createIronswornOracleTree(): Promise<IOracleTreeNode> {
+async function createIronswornOracleTree(): Promise<IOracleTreeNode> {
 	return await createOracleTree(
 		'foundry-ironsworn.ironswornoracles',
 		ISOracleCategories
 	)
 }
 
-export async function createStarforgedOracleTree(): Promise<IOracleTreeNode> {
+async function createStarforgedOracleTree(): Promise<IOracleTreeNode> {
 	return await createOracleTree(
 		'foundry-ironsworn.starforgedoracles',
 		SFOracleCategories
@@ -107,9 +100,9 @@ export async function walkOracle(
 	const node: IOracleTreeNode = {
 		...emptyNode(),
 		dataforgedNode: oracle,
-		tables: compact([table != null ? () => table : undefined]),
+		tables: compact([table?.uuid]),
 		displayName:
-			table?.name ||
+			table?.name ??
 			game.i18n.localize(`IRONSWORN.OracleCategories.${oracle.Name}`)
 	}
 
@@ -127,7 +120,7 @@ export async function walkOracle(
 				node.children.push({
 					...emptyNode(),
 					displayName: name,
-					tables: [() => subtable]
+					tables: [subtable.uuid]
 				})
 			}
 		}
@@ -155,7 +148,7 @@ async function augmentWithFolderContents(node: IOracleTreeNode) {
 		// Add this folder
 		const newNode: IOracleTreeNode = {
 			...emptyNode(),
-			displayName: folder.name || '(folder)'
+			displayName: folder.name ?? '(folder)'
 		}
 		parent.children.push(newNode)
 
@@ -168,7 +161,7 @@ async function augmentWithFolderContents(node: IOracleTreeNode) {
 		for (const table of folder.contents) {
 			newNode.children.push({
 				...emptyNode(),
-				tables: [() => table as RollTable],
+				tables: [table.uuid],
 				displayName: table.name ?? '(table)'
 			})
 		}
@@ -177,14 +170,14 @@ async function augmentWithFolderContents(node: IOracleTreeNode) {
 	walkFolder(node, rootFolder)
 }
 
-export function findPathToNodeByTableId(
+export function findPathToNodeByTableUuid(
 	rootNode: IOracleTreeNode,
-	tableId: string
+	tableUuid: string
 ): IOracleTreeNode[] {
 	const ret: IOracleTreeNode[] = []
 	function walk(node: IOracleTreeNode) {
 		ret.push(node)
-		const foundTable = node.tables.find((x) => x().id === tableId)
+		const foundTable = node.tables.find((x) => x === tableUuid)
 		if (foundTable != null) return true
 		for (const child of node.children) {
 			if (walk(child)) return true
@@ -212,3 +205,64 @@ export function findPathToNodeByDfId(rootNode: IOracleTreeNode, dfId: string) {
 	walk(rootNode)
 	return ret
 }
+
+type OracleCategory = 'ironsworn' | 'starforged'
+
+const ORACLES: Record<OracleCategory, IOracleTreeNode> = {
+	ironsworn: emptyNode(),
+	starforged: emptyNode()
+}
+
+export function registerOracleTreeInternal(
+	category: OracleCategory,
+	rootNode: IOracleTreeNode
+) {
+	ORACLES[category] = rootNode
+}
+
+let defaultTreesInitialized = false
+
+export async function registerDefaultOracleTrees() {
+	const ironswornOracles = await createIronswornOracleTree()
+	registerOracleTreeInternal('ironsworn', ironswornOracles)
+
+	const starforgedOracles = await createStarforgedOracleTree()
+	registerOracleTreeInternal('starforged', starforgedOracles)
+
+	defaultTreesInitialized = true
+}
+
+// Available in browser
+export function registerOracleTree(
+	category: OracleCategory,
+	rootNode: IOracleTreeNode
+) {
+	// Check if internal registrations have been done
+	// If not, do nothing and send a warning to the UI
+	if (!defaultTreesInitialized) {
+		const message =
+			'Not ready yet. Call registerOracleTree from a "ready" hook please.'
+		ui.notifications?.warn(message)
+		throw new Error(message)
+	}
+
+	registerOracleTreeInternal(category, rootNode)
+}
+
+export function getOracleTree(category: OracleCategory): IOracleTreeNode {
+	return cloneDeep(ORACLES[category])
+}
+
+export async function getOracleTreeWithCustomOracles(
+	category: OracleCategory
+): Promise<IOracleTreeNode> {
+	const rootNode = getOracleTree(category)
+
+	// Add in custom oracles from a well-known directory
+	await augmentWithFolderContents(rootNode)
+
+	// Fire the hook and allow extensions to modify the tree
+	Hooks.call('ironswornOracles', rootNode)
+
+	return rootNode
+}

src/module/rolls/oracle-roll-message.ts

@@ -3,10 +3,9 @@ import { compact, pick, sortBy } from 'lodash-es'
 import { marked } from 'marked'
 import { getFoundryTableByDfId } from '../dataforged'
 import {
-	createIronswornOracleTree,
-	createStarforgedOracleTree,
 	findPathToNodeByDfId,
-	findPathToNodeByTableId
+	findPathToNodeByTableUuid,
+	getOracleTreeWithCustomOracles
 } from '../features/customoracles'
 
 export interface TableRow {
@@ -68,9 +67,9 @@ export class OracleRollMessage {
 
 	static async fromDfOracleId(dfOracleId: string): Promise<OracleRollMessage> {
 		// Subtitle can be inferred from the structure of the DF ID
-		const oracleTreeRoot = await (dfOracleId.startsWith('Ironsworn/')
-			? createIronswornOracleTree
-			: createStarforgedOracleTree)()
+		const oracleTreeRoot = await getOracleTreeWithCustomOracles(
+			dfOracleId.startsWith('Ironsworn/') ? 'ironsworn' : 'starforged'
+		)
 		const pathElements = findPathToNodeByDfId(oracleTreeRoot, dfOracleId)
 		const pathNames = pathElements.map((x) => x.displayName)
 		pathNames.shift() // root node has no display name
@@ -172,18 +171,17 @@ export class OracleRollMessage {
 	}
 
 	private async oraclePath(): Promise<string | undefined> {
-		if (!this.tableUuid) return undefined
-		const uuid = _parseUuid(this.tableUuid)
+		if (this.tableUuid == null) return undefined
+
+		const starforgedRoot = await getOracleTreeWithCustomOracles('starforged')
+		const ironswornRoot = await getOracleTreeWithCustomOracles('ironsworn')
 
-		const [starforgedRoot, ironswornRooot] = await Promise.all([
-			createStarforgedOracleTree(),
-			createIronswornOracleTree()
-		])
 		const pathElements =
-			findPathToNodeByTableId(starforgedRoot, uuid.documentId!) ??
-			findPathToNodeByTableId(ironswornRooot, uuid.documentId!)
+			findPathToNodeByTableUuid(starforgedRoot, this.tableUuid) ??
+			findPathToNodeByTableUuid(ironswornRoot, this.tableUuid)
 		pathElements.shift() // no display name for root node
 		pathElements.pop() // last node is the table we rolled
+
 		return pathElements.map((x) => x.displayName).join(' / ')
 	}
 

src/module/vue/components/buttons/btn-oracle.vue

@@ -39,7 +39,7 @@ async function rollOracle() {
 	if (props.overrideClick && props.onClick) return $emit('click')
 
 	const randomTable = sample(props.node.tables)
-	const orm = await OracleRollMessage.fromTableUuid(randomTable?.()?.uuid ?? '')
+	const orm = await OracleRollMessage.fromTableUuid(randomTable ?? '')
 	orm.createOrUpdate()
 }
 </script>

src/module/vue/components/oracle-tree-node.vue

@@ -24,7 +24,8 @@
 				<RulesTextOracle
 					v-if="state.descriptionExpanded"
 					:class="$style.content"
-					:oracle-table="node.tables[0]"
+					:table-rows="state.tableRows"
+					:table-description="state.tableDescription"
 					:source="node.dataforgedNode?.Source"
 					@moveclick="moveclick"
 					@oracleclick="oracleclick" />
@@ -65,7 +66,7 @@
 </template>
 
 <script setup lang="ts">
-import { computed, reactive, ref } from 'vue'
+import { computed, nextTick, reactive, ref } from 'vue'
 import type { IOracleTreeNode } from '../../features/customoracles'
 import { FontAwesome } from './icon/icon-common'
 import BtnOracle from './buttons/btn-oracle.vue'
@@ -78,9 +79,19 @@ import IronIcon from './icon/iron-icon.vue'
 
 const props = defineProps<{ node: IOracleTreeNode }>()
 
+// FIXME: use v10 types when available, or hack some together for tables
+type TableRowData = {
+	low: number
+	high: number
+	text: string
+	selected: boolean
+}
+
 const state = reactive({
 	manuallyExpanded: props.node.forceExpanded ?? false,
 	descriptionExpanded: false,
+	tableRows: [] as Array<TableRowData>,
+	tableDescription: '',
 	highlighted: false
 })
 
@@ -90,7 +101,18 @@ const isLeaf = computed(() => {
 	return props.node.tables.length > 0
 })
 
-function toggleDescription() {
+async function toggleDescription() {
+	if (!state.tableDescription) {
+		const table = (await fromUuid(props.node.tables[0])) as RollTable
+		state.tableRows = table.results.map((row: any) => ({
+			low: row.range[0],
+			high: row.range[1],
+			text: row.text,
+			selected: false
+		}))
+		state.tableDescription = (table as any).description ?? ''
+		await nextTick()
+	}
 	state.descriptionExpanded = !state.descriptionExpanded
 }
 function toggleManually() {