create-pixi-vn 2.0.14 → 2.1.0

package/template-nqtr-react-vite-muijoy-tauri/src/pixi-vn.d.ts

@@ -1,128 +1,122 @@
-import { OnRunProps } from "@drincs/nqtr";
-import { TFunction } from "i18next";
-import { OptionsWithExtraProps, SnackbarKey, SnackbarMessage } from "notistack";
-import { NavigateFunction } from "react-router-dom";
-
-declare module "@drincs/pixi-vn" {
-    interface StepLabelResult {
-        [key: string]: any;
-    }
-    interface StepLabelProps {
-        /**
-         * function to navigate to a new route.
-         * @param route The route to navigate to.
-         * @returns
-         */
-        navigate: NavigateFunction;
-        /**
-         * Translate a key to a string.
-         * @param key The key to translate.
-         * @returns The translated string.
-         */
-        t: TFunction<[string], undefined>;
-        /**
-         * Translate a key to a string using the UI strings.
-         * @param key The key to translate.
-         * @returns The translated string.
-         */
-        uiTransition: TFunction<[string], undefined>;
-        /**
-         * Show a notification.
-         * @param message The message to show.
-         * @param variant The variant of the notification.
-         * @returns
-         */
-        notify: (
-            message: SnackbarMessage,
-            options?: OptionsWithExtraProps<"default" | "error" | "success" | "warning" | "info">,
-        ) => SnackbarKey;
-        /**
-         * Invalidate the interface data.
-         * This will cause the interface to be reloaded and the data to be fetched again.
-         * @param delay The delay before invalidating the data. This can be used to wait for some time before invalidating the data, for example, to wait for an animation to finish.
-         */
-        invalidateInterfaceData: (delay?: number) => Promise<void> | void;
-        /**
-         * Sleep for a new day.
-         * @param newDayHour The hour of the new day.
-         * @param props The props of the step label.
-         * @returns Whether the sleep was successful.
-         */
-        sleep: (newDayHour: number, props: OnRunProps) => boolean;
-        /**
-         * Wait for a certain amount of time.
-         * @param timeSpent The amount of time to wait.
-         * @returns Whether the wait was successful.
-         */
-        wait: (timeSpent: number) => boolean;
-    }
-    interface CharacterInterface {
-        /**
-         * The name of the character.
-         * If you set undefined, it will return the default name.
-         */
-        name: string;
-        /**
-         * The surname of the character.
-         * If you set undefined, it will return the default surname.
-         */
-        surname?: string;
-        /**
-         * The age of the character.
-         * If you set undefined, it will return the default age.
-         */
-        age?: number;
-        /**
-         * The icon of the character.
-         */
-        readonly icon?: string;
-        /**
-         * The color of the character.
-         */
-        readonly color?: string;
-    }
-    interface DialogueInterface {
-        /**
-         * The text of the dialogue.
-         */
-        text: string | string[];
-        /**
-         * The id of the character that is speaking.
-         */
-        character?: CharacterInterface | string;
-    }
-    interface ChoiceInterface {
-        /**
-         * Text to be displayed in the menu
-         */
-        text: string;
-        /**
-         * Label Id to be opened when the option is selected
-         */
-        label: LabelIdType | CloseType;
-        /**
-         * Type of the label to be opened
-         */
-        type: LabelRunModeType | CloseType;
-        /**
-         * If this is true, the choice can only be made once.
-         */
-        oneTime?: boolean;
-        /**
-         * If this is true, the choice can see only if there are no other choices. For example, all choices are one-time choices and they are already selected.
-         */
-        onlyHaveNoChoice?: boolean;
-        /**
-         * If this is true and if is the only choice, it will be automatically selected, and call/jump to the label.
-         */
-        autoSelect?: boolean;
-        /**
-         * If true, the current label will be closed
-         */
-        closeCurrentLabel?: boolean;
-        /**
-         * Properties to be passed to the label and olther parameters that you can use when get all the choice menu options.
-         */
-        props?: StorageObjectType;
-    }
-}
+import type { UseNavigateResult } from "@tanstack/react-router";
+import type { TFunction } from "i18next";
+import type { toast } from "sonner";
+
+declare module "@drincs/pixi-vn" {
+    interface StepLabelResult {
+        [key: string]: any;
+    }
+    interface StepLabelProps {
+        /**
+         * function to navigate to a new route.
+         * @param route The route to navigate to.
+         * @returns
+         */
+        navigate: UseNavigateResult<string>;
+        /**
+         * Translate a key to a string.
+         * @param key The key to translate.
+         * @returns The translated string.
+         */
+        t: TFunction<[string], undefined>;
+        /**
+         * Translate a key to a string using the UI strings.
+         * @param key The key to translate.
+         * @returns The translated string.
+         */
+        uiTransition: TFunction<[string], undefined>;
+        /**
+         * Show a notification.
+         * @param message The message to show in the notification.
+         */
+        toast: typeof toast;
+        /**
+         * Invalidate the interface data.
+         * This will cause the interface to be reloaded and the data to be fetched again.
+         * @param delay The delay before invalidating the data. This can be used to wait for some time before invalidating the data, for example, to wait for an animation to finish.
+         */
+        invalidateInterfaceData: (delay?: number) => Promise<void> | void;
+        /**
+         * Sleep for a new day.
+         * @param newDayHour The hour of the new day.
+         * @param props The props of the step label.
+         * @returns Whether the sleep was successful.
+         */
+        sleep: (newDayHour: number, props: OnRunProps) => boolean;
+        /**
+         * Wait for a certain amount of time.
+         * @param timeSpent The amount of time to wait.
+         * @returns Whether the wait was successful.
+         */
+        wait: (timeSpent: number) => boolean;
+    }
+    interface CharacterInterface {
+        /**
+         * The name of the character.
+         * If you set undefined, it will return the default name.
+         */
+        name: string;
+        /**
+         * The surname of the character.
+         * If you set undefined, it will return the default surname.
+         */
+        surname?: string;
+        /**
+         * The age of the character.
+         * If you set undefined, it will return the default age.
+         */
+        age?: number;
+        /**
+         * The icon of the character.
+         */
+        readonly icon?: string;
+        /**
+         * The color of the character.
+         */
+        readonly color?: string;
+    }
+    interface DialogueInterface {
+        /**
+         * The text of the dialogue.
+         */
+        text: string | string[];
+        /**
+         * The id of the character that is speaking.
+         */
+        character?: CharacterInterface | string;
+    }
+    interface ChoiceInterface {
+        /**
+         * Text to be displayed in the menu
+         */
+        text: string;
+        /**
+         * Label Id to be opened when the option is selected
+         */
+        label: LabelIdType | CloseType;
+        /**
+         * Type of the label to be opened
+         */
+        type: LabelRunModeType | CloseType;
+        /**
+         * If this is true, the choice can only be made once.
+         */
+        oneTime?: boolean;
+        /**
+         * If this is true, the choice can see only if there are no other choices. For example, all choices are one-time choices and they are already selected.
+         */
+        onlyHaveNoChoice?: boolean;
+        /**
+         * If this is true and if is the only choice, it will be automatically selected, and call/jump to the label.
+         */
+        autoSelect?: boolean;
+        /**
+         * If true, the current label will be closed
+         */
+        closeCurrentLabel?: boolean;
+        /**
+         * Properties to be passed to the label and olther parameters that you can use when get all the choice menu options.
+         */
+        props?: StorageObjectType;
+    }
+}

package/template-nqtr-react-vite-muijoy-tauri/src/pixi-vn.keys.gen.ts

@@ -0,0 +1,86 @@
+/* eslint-disable */
+// noinspection JSUnusedGlobalSymbols
+// This file is auto-generated by @drincs/pixi-vn vite plugin. Do not edit manually.
+declare module "@drincs/pixi-vn/characters" {
+    interface PixivnCharacterIds {
+        "mc": never;
+        "alice": never;
+    }
+}
+declare module "@drincs/pixi-vn/narration" {
+    interface PixivnLabelIds {
+        "sleep_1_hour": never;
+        "nap_1_hour": never;
+        "sleep": never;
+        "nap": never;
+        "start": never;
+        "order_product": never;
+        "talk_alice_sleep_result": never;
+        "talk_alice_sleep": never;
+        "talk_alice": never;
+        "alice_talk_menu": never;
+        "take_product": never;
+    }
+}
+declare module "@drincs/pixi-vn/canvas" {
+    interface PixivnBundleIds {
+        "default": never;
+        "audio": never;
+        "/": never;
+        "main_map": never;
+        "nightcity_map": never;
+        "mc_room": never;
+        "alice_room": never;
+        "ann_room": never;
+        "bathroom": never;
+        "lounge": never;
+        "terrace": never;
+        "gym_room": never;
+        "alice": never;
+    }
+    interface PixivnAssetAliasIds {
+        "bgm_cheerful": never;
+        "sfx_whoosh": never;
+        "background_main_menu": never;
+        "map-0": never;
+        "map-1": never;
+        "map-2": never;
+        "map-3": never;
+        "icon_location_home": never;
+        "icon_location_gym": never;
+        "map-nightcity": never;
+        "location_myroom-0": never;
+        "location_myroom-1": never;
+        "location_myroom-2": never;
+        "location_myroom-3": never;
+        "location_aliceroom-0": never;
+        "location_aliceroom-1": never;
+        "location_aliceroom-2": never;
+        "location_aliceroom-3": never;
+        "location_annroom-0": never;
+        "location_annroom-1": never;
+        "location_annroom-2": never;
+        "location_annroom-3": never;
+        "location_bathroom": never;
+        "location_lounge-0": never;
+        "location_lounge-1": never;
+        "location_lounge-2": never;
+        "location_lounge-3": never;
+        "location_terrace-0": never;
+        "location_terrace-1": never;
+        "location_terrace-2": never;
+        "location_terrace-3": never;
+        "location_gym": never;
+        "alice_terrace0A": never;
+        "alice_terrace0At": never;
+        "alice_roomsleep0A": never;
+    }
+}
+export const characterIds = ["mc","alice"] as const;
+export const characterIdsEnum = {"mc":"mc","alice":"alice"} as const;
+export const labelIds = ["sleep_1_hour","nap_1_hour","sleep","nap","start","order_product","talk_alice_sleep_result","talk_alice_sleep","talk_alice","alice_talk_menu","take_product"] as const;
+export const labelIdsEnum = {"sleep_1_hour":"sleep_1_hour","nap_1_hour":"nap_1_hour","sleep":"sleep","nap":"nap","start":"start","order_product":"order_product","talk_alice_sleep_result":"talk_alice_sleep_result","talk_alice_sleep":"talk_alice_sleep","talk_alice":"talk_alice","alice_talk_menu":"alice_talk_menu","take_product":"take_product"} as const;
+export const bundleIds = ["default","audio","/","main_map","nightcity_map","mc_room","alice_room","ann_room","bathroom","lounge","terrace","gym_room","alice"] as const;
+export const bundleIdsEnum = {"default":"default","audio":"audio","/":"/","main_map":"main_map","nightcity_map":"nightcity_map","mc_room":"mc_room","alice_room":"alice_room","ann_room":"ann_room","bathroom":"bathroom","lounge":"lounge","terrace":"terrace","gym_room":"gym_room","alice":"alice"} as const;
+export const assetAliasIds = ["bgm_cheerful","sfx_whoosh","background_main_menu","map-0","map-1","map-2","map-3","icon_location_home","icon_location_gym","map-nightcity","location_myroom-0","location_myroom-1","location_myroom-2","location_myroom-3","location_aliceroom-0","location_aliceroom-1","location_aliceroom-2","location_aliceroom-3","location_annroom-0","location_annroom-1","location_annroom-2","location_annroom-3","location_bathroom","location_lounge-0","location_lounge-1","location_lounge-2","location_lounge-3","location_terrace-0","location_terrace-1","location_terrace-2","location_terrace-3","location_gym","alice_terrace0A","alice_terrace0At","alice_roomsleep0A"] as const;
+export const assetAliasIdsEnum = {"bgm_cheerful":"bgm_cheerful","sfx_whoosh":"sfx_whoosh","background_main_menu":"background_main_menu","map-0":"map-0","map-1":"map-1","map-2":"map-2","map-3":"map-3","icon_location_home":"icon_location_home","icon_location_gym":"icon_location_gym","map-nightcity":"map-nightcity","location_myroom-0":"location_myroom-0","location_myroom-1":"location_myroom-1","location_myroom-2":"location_myroom-2","location_myroom-3":"location_myroom-3","location_aliceroom-0":"location_aliceroom-0","location_aliceroom-1":"location_aliceroom-1","location_aliceroom-2":"location_aliceroom-2","location_aliceroom-3":"location_aliceroom-3","location_annroom-0":"location_annroom-0","location_annroom-1":"location_annroom-1","location_annroom-2":"location_annroom-2","location_annroom-3":"location_annroom-3","location_bathroom":"location_bathroom","location_lounge-0":"location_lounge-0","location_lounge-1":"location_lounge-1","location_lounge-2":"location_lounge-2","location_lounge-3":"location_lounge-3","location_terrace-0":"location_terrace-0","location_terrace-1":"location_terrace-1","location_terrace-2":"location_terrace-2","location_terrace-3":"location_terrace-3","location_gym":"location_gym","alice_terrace0A":"alice_terrace0A","alice_terrace0At":"alice_terrace0At","alice_roomsleep0A":"alice_roomsleep0A"} as const;

package/template-nqtr-react-vite-muijoy-tauri/src/routeTree.gen.ts

@@ -0,0 +1,150 @@
+/* eslint-disable */
+
+// @ts-nocheck
+
+// noinspection JSUnusedGlobalSymbols
+
+// This file was automatically generated by TanStack Router.
+// You should NOT make any changes in this file as it will be overwritten.
+// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified.
+
+import { Route as rootRouteImport } from './routes/__root'
+import { Route as GameRouteImport } from './routes/game'
+import { Route as IndexRouteImport } from './routes/index'
+import { Route as GameNavigationRouteImport } from './routes/game/navigation'
+import { Route as GameNarrationRouteImport } from './routes/game/narration'
+import { Route as GameMapRouteImport } from './routes/game/map'
+
+const GameRoute = GameRouteImport.update({
+  id: '/game',
+  path: '/game',
+  getParentRoute: () => rootRouteImport,
+} as any)
+const IndexRoute = IndexRouteImport.update({
+  id: '/',
+  path: '/',
+  getParentRoute: () => rootRouteImport,
+} as any)
+const GameNavigationRoute = GameNavigationRouteImport.update({
+  id: '/navigation',
+  path: '/navigation',
+  getParentRoute: () => GameRoute,
+} as any)
+const GameNarrationRoute = GameNarrationRouteImport.update({
+  id: '/narration',
+  path: '/narration',
+  getParentRoute: () => GameRoute,
+} as any)
+const GameMapRoute = GameMapRouteImport.update({
+  id: '/map',
+  path: '/map',
+  getParentRoute: () => GameRoute,
+} as any)
+
+export interface FileRoutesByFullPath {
+  '/': typeof IndexRoute
+  '/game': typeof GameRouteWithChildren
+  '/game/map': typeof GameMapRoute
+  '/game/narration': typeof GameNarrationRoute
+  '/game/navigation': typeof GameNavigationRoute
+}
+export interface FileRoutesByTo {
+  '/': typeof IndexRoute
+  '/game': typeof GameRouteWithChildren
+  '/game/map': typeof GameMapRoute
+  '/game/narration': typeof GameNarrationRoute
+  '/game/navigation': typeof GameNavigationRoute
+}
+export interface FileRoutesById {
+  __root__: typeof rootRouteImport
+  '/': typeof IndexRoute
+  '/game': typeof GameRouteWithChildren
+  '/game/map': typeof GameMapRoute
+  '/game/narration': typeof GameNarrationRoute
+  '/game/navigation': typeof GameNavigationRoute
+}
+export interface FileRouteTypes {
+  fileRoutesByFullPath: FileRoutesByFullPath
+  fullPaths:
+    | '/'
+    | '/game'
+    | '/game/map'
+    | '/game/narration'
+    | '/game/navigation'
+  fileRoutesByTo: FileRoutesByTo
+  to: '/' | '/game' | '/game/map' | '/game/narration' | '/game/navigation'
+  id:
+    | '__root__'
+    | '/'
+    | '/game'
+    | '/game/map'
+    | '/game/narration'
+    | '/game/navigation'
+  fileRoutesById: FileRoutesById
+}
+export interface RootRouteChildren {
+  IndexRoute: typeof IndexRoute
+  GameRoute: typeof GameRouteWithChildren
+}
+
+declare module '@tanstack/react-router' {
+  interface FileRoutesByPath {
+    '/game': {
+      id: '/game'
+      path: '/game'
+      fullPath: '/game'
+      preLoaderRoute: typeof GameRouteImport
+      parentRoute: typeof rootRouteImport
+    }
+    '/': {
+      id: '/'
+      path: '/'
+      fullPath: '/'
+      preLoaderRoute: typeof IndexRouteImport
+      parentRoute: typeof rootRouteImport
+    }
+    '/game/navigation': {
+      id: '/game/navigation'
+      path: '/navigation'
+      fullPath: '/game/navigation'
+      preLoaderRoute: typeof GameNavigationRouteImport
+      parentRoute: typeof GameRoute
+    }
+    '/game/narration': {
+      id: '/game/narration'
+      path: '/narration'
+      fullPath: '/game/narration'
+      preLoaderRoute: typeof GameNarrationRouteImport
+      parentRoute: typeof GameRoute
+    }
+    '/game/map': {
+      id: '/game/map'
+      path: '/map'
+      fullPath: '/game/map'
+      preLoaderRoute: typeof GameMapRouteImport
+      parentRoute: typeof GameRoute
+    }
+  }
+}
+
+interface GameRouteChildren {
+  GameMapRoute: typeof GameMapRoute
+  GameNarrationRoute: typeof GameNarrationRoute
+  GameNavigationRoute: typeof GameNavigationRoute
+}
+
+const GameRouteChildren: GameRouteChildren = {
+  GameMapRoute: GameMapRoute,
+  GameNarrationRoute: GameNarrationRoute,
+  GameNavigationRoute: GameNavigationRoute,
+}
+
+const GameRouteWithChildren = GameRoute._addFileChildren(GameRouteChildren)
+
+const rootRouteChildren: RootRouteChildren = {
+  IndexRoute: IndexRoute,
+  GameRoute: GameRouteWithChildren,
+}
+export const routeTree = rootRouteImport
+  ._addFileChildren(rootRouteChildren)
+  ._addFileTypes<FileRouteTypes>()

package/template-nqtr-react-vite-muijoy-tauri/src/router.tsx

@@ -0,0 +1,27 @@
+import { PendingComponent } from "@/components/loading";
+import { routeTree } from "@/routeTree.gen";
+import type { QueryClient } from "@tanstack/react-query";
+import { createRouter as createTanStackRouter } from "@tanstack/react-router";
+
+export interface RouterContext {
+    queryClient: QueryClient;
+}
+
+export function getRouter(context: RouterContext) {
+    const router = createTanStackRouter({
+        routeTree,
+        context,
+        scrollRestoration: true,
+        defaultPreload: "intent",
+        defaultPreloadStaleTime: 0,
+        defaultPendingComponent: PendingComponent,
+    });
+
+    return router;
+}
+
+declare module "@tanstack/react-router" {
+    interface Register {
+        router: ReturnType<typeof getRouter>;
+    }
+}

package/template-nqtr-react-vite-muijoy-tauri/src/routes/__root.tsx

@@ -0,0 +1,66 @@
+import { PendingComponent } from "@/components/loading";
+import { MemoMenu } from "@/components/menus/memo-menu";
+import { SettingsDialogue } from "@/components/menus/settings";
+import { OfflineAllert } from "@/components/modals/error-allerts";
+import { RootProvider } from "@/components/providers/root-provider";
+import { INTERFACE_DATA_USE_QUERY_KEY } from "@/constants";
+import { useConfirmBackNavigation } from "@/lib/hooks/navigation-hooks";
+import { useAutoSaveOnPageClose } from "@/lib/hooks/save-hooks";
+import { useI18n } from "@/lib/i18n";
+import { SearchParams } from "@/lib/stores/search-param-store";
+import { defineAssets } from "@/lib/utils/assets-utility";
+import { initializeIndexedDB } from "@/lib/utils/db-utility";
+import { loadRefreshSave } from "@/lib/utils/save-utility";
+import type { RouterContext } from "@/router";
+import { narration } from "@drincs/pixi-vn";
+import { setupPixivnViteData } from "@drincs/pixi-vn/vite-listener";
+import { createRootRouteWithContext, ErrorComponent, Outlet } from "@tanstack/react-router";
+import { lazy, Suspense } from "react";
+
+const DevDevtools = import.meta.env.DEV ? lazy(() => import("@/components/dev-devtools")) : null;
+
+export const Route = createRootRouteWithContext<RouterContext>()({
+    validateSearch: (search) => SearchParams.setMany(search),
+    component: RootComponent,
+    pendingComponent: PendingComponent,
+    loader: async ({ context, location }) => {
+        // Game.onNavigate(async (to) => redirect({ to }));
+        await Promise.all([import("@/content"), initializeIndexedDB(), defineAssets(), useI18n()]);
+        await setupPixivnViteData();
+        if (location.pathname !== "/" && narration.stepCounter === 0) {
+            const isRefreshSaveExist = await loadRefreshSave();
+            if (isRefreshSaveExist) {
+                await context.queryClient.invalidateQueries({
+                    queryKey: [INTERFACE_DATA_USE_QUERY_KEY],
+                });
+            }
+        }
+    },
+    errorComponent: (props) => (
+        <div className="bg-background pointer-events-auto hover:text-foreground">
+            <ErrorComponent {...props} />
+        </div>
+    ),
+});
+
+function RootComponent() {
+    useAutoSaveOnPageClose();
+    useConfirmBackNavigation();
+
+    return (
+        <>
+            <RootProvider>
+                <SettingsDialogue />
+                <MemoMenu />
+                <OfflineAllert />
+                <Outlet />
+            </RootProvider>
+
+            {DevDevtools && (
+                <Suspense>
+                    <DevDevtools />
+                </Suspense>
+            )}
+        </>
+    );
+}

package/template-nqtr-react-vite-muijoy-tauri/src/routes/game/map.tsx

@@ -0,0 +1,6 @@
+import MapScreen from "@/components/screens/map";
+import { createFileRoute } from "@tanstack/react-router";
+
+export const Route = createFileRoute("/game/map")({
+    component: MapScreen,
+});

package/template-nqtr-react-vite-muijoy-tauri/src/routes/game/narration.tsx

@@ -0,0 +1,21 @@
+import { NarrationScreen } from "@/components/screens/narration";
+import { NarrationClickOverlay } from "@/components/screens/narration/click-overlay";
+import { useNarrationHotkeys } from "@/lib/hooks/hotkeys-hooks";
+import { useSkipAutoDetector } from "@/lib/hooks/narration-hooks";
+import { createFileRoute } from "@tanstack/react-router";
+
+export const Route = createFileRoute("/game/narration")({
+    component: NarrationElement,
+});
+
+function NarrationElement() {
+    useSkipAutoDetector();
+    useNarrationHotkeys();
+
+    return (
+        <>
+            <NarrationClickOverlay />
+            <NarrationScreen />
+        </>
+    );
+}

package/template-nqtr-react-vite-muijoy-tauri/src/routes/game/navigation.tsx

@@ -0,0 +1,15 @@
+import { NavigationScreen } from "@/components/screens/navigation";
+import { useNavigationHotkeys } from "@/lib/hooks/hotkeys-hooks";
+import { useRoomLayerSync } from "@/lib/hooks/nqtr-hooks";
+import { createFileRoute } from "@tanstack/react-router";
+
+export const Route = createFileRoute("/game/navigation")({
+    component: RouteComponent,
+});
+
+function RouteComponent() {
+    useRoomLayerSync();
+    useNavigationHotkeys();
+
+    return <NavigationScreen />;
+}

package/template-nqtr-react-vite-muijoy-tauri/src/routes/game.tsx

@@ -0,0 +1,22 @@
+import { InputRequestDialog } from "@/components/modals/input-request-dialogues";
+import { QuickActionsWheel } from "@/components/modals/quick-actions-wheel";
+import { useGameHotkeys } from "@/lib/hooks/hotkeys-hooks";
+import { usePauseGameWhenMenuIsOpen } from "@/lib/hooks/pause-game-hooks";
+import { createFileRoute, Outlet } from "@tanstack/react-router";
+
+export const Route = createFileRoute("/game")({
+    component: GameElement,
+});
+
+function GameElement() {
+    usePauseGameWhenMenuIsOpen();
+    useGameHotkeys();
+
+    return (
+        <>
+            <InputRequestDialog />
+            <QuickActionsWheel />
+            <Outlet />
+        </>
+    );
+}