@kite3d/engine 0.15.0

package/src/defaults.ts

@@ -0,0 +1,277 @@
+import type {ProjectConfigSettings} from './runtime/projectFormat.ts'
+
+export const emptyProjectSettings = {
+    plugins: [
+        {
+            "import": "threepipe",
+            "className": "SSAAPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "AssetExporterPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "TransformAnimationPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "DepthBufferPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "NormalBufferPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "FullScreenPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "ObjectConstraintsPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "TransformControlsPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "AssetExporterPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "ClearcoatTintPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "FragmentClippingExtensionPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "NoiseBumpMaterialPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "CustomBumpMapPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "ParallaxMappingPlugin",
+            "params": [
+                false
+            ]
+        },
+        {
+            "import": "threepipe",
+            "className": "GLTFKHRMaterialVariantsPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "VirtualCamerasPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "RenderTargetPreviewPlugin",
+            "params": [
+                false
+            ]
+        },
+        {
+            "import": "threepipe",
+            "className": "HDRiGroundPlugin",
+            "params": [
+                false,
+                true
+            ]
+        },
+        {
+            "import": "threepipe",
+            "className": "VignettePlugin",
+            "params": [
+                false
+            ]
+        },
+        {
+            "import": "threepipe",
+            "className": "ChromaticAberrationPlugin",
+            "params": [
+                false
+            ]
+        },
+        {
+            "import": "threepipe",
+            "className": "FilmicGrainPlugin",
+            "params": [
+                false
+            ]
+        },
+        {
+            "import": "threepipe",
+            "className": "SSAOPlugin",
+            "params": [
+                1009,
+                1
+            ]
+        },
+        {
+            "import": "threepipe",
+            "className": "ContactShadowGroundPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "DeviceOrientationControlsPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "PointerLockControlsPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "ThreeFirstPersonControlsPlugin"
+        },
+        {
+            "import": "threepipe",
+            "className": "MeshOptSimplifyModifierPlugin",
+            "params": [
+                false
+            ]
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "AnisotropyPlugin",
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "BloomPlugin",
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "SSReflectionPlugin",
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "TemporalAAPlugin",
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "VelocityBufferPlugin",
+            params: [1009, false],
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "DepthOfFieldPlugin",
+            params: [false],
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "SSContactShadowsPlugin",
+            params: [false],
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "OutlinePlugin",
+            params: [false],
+        },
+        {
+            "import": "@threepipe/webgi-plugins",
+            "className": "SSGIPlugin",
+            params: [undefined, 1, false],
+        },
+        // GLTFDracoExportPlugin, GLTFSpecGlossinessConverterPlugin
+        {
+            "import": "@threepipe/plugin-gltf-transform",
+            "className": "GLTFDracoExportPlugin",
+        },
+        {
+            "import": "@threepipe/plugin-gltf-transform",
+            "className": "GLTFSpecGlossinessConverterPlugin",
+        },
+        // MaterialConfiguratorPlugin, SwitchNodePlugin
+        {
+            "import": "@threepipe/plugin-configurator",
+            "className": "MaterialConfiguratorPlugin",
+        },
+        {
+            "import": "@threepipe/plugin-configurator",
+            "className": "SwitchNodePlugin",
+        },
+        ...['B3DMLoadPlugin', 'CMPTLoadPlugin', 'DeepZoomImageLoadPlugin', 'EnvironmentControlsPlugin', 'GlobeControlsPlugin', 'I3DMLoadPlugin', 'PNTSLoadPlugin', 'TilesRendererPlugin'].map(className => ({
+            import: '@threepipe/plugin-3d-tiles-renderer',
+            className,
+        })),
+        {
+            import: '@threepipe/plugin-assimpjs',
+            className: 'AssimpJsPlugin',
+            params: [false],
+        },
+        {
+            import: '@threepipe/plugin-path-tracing',
+            className: 'ThreeGpuPathTracerPlugin',
+            params: [false],
+        },
+        {
+            import: '@threepipe/plugin-blend-importer',
+            className: 'BlendLoadPlugin',
+        },
+        {
+            import: '@threepipe/plugin-network',
+            className: 'TransfrSharePlugin',
+        },
+        {
+            import: '@threepipe/plugin-troika-text',
+            className: 'TroikaTextPlugin',
+        },
+        ...[
+            'TDSLoadPlugin',
+            'ThreeMFLoadPlugin',
+            'ColladaLoadPlugin',
+            'AMFLoadPlugin',
+            'GCodeLoadPlugin',
+            'BVHLoadPlugin',
+            'VOXLoadPlugin',
+            'MDDLoadPlugin',
+            'PCDLoadPlugin',
+            'TiltLoadPlugin',
+            'VRMLLoadPlugin',
+            'LDrawLoadPlugin',
+            'VTKLoadPlugin',
+            'XYZLoadPlugin',
+        ].map(className => ({
+            import: '@threepipe/plugins-extra-importers',
+            className,
+        })),
+    ],
+    dependencies: [{
+        key: '@threepipe/webgi-plugins',
+        version: '0.6.1',
+    }, {
+        key: '@threepipe/plugin-gltf-transform',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugin-configurator',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugin-3d-tiles-renderer',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugin-assimpjs',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugin-path-tracing',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugin-blend-importer',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugin-network',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugin-troika-text',
+        version: 'latest',
+    }, {
+        key: '@threepipe/plugins-extra-importers',
+        version: 'latest',
+    }],
+    scripts: [],
+    viewer: {},
+} as ProjectConfigSettings

package/src/fileTypes.ts

@@ -0,0 +1,53 @@
+export type Kite3dFileType = 'plugin' | 'script' | 'material' | 'image'
+
+export const typesExts: Partial<Record<Kite3dFileType, string[]>> = {
+    'plugin': ['.plugin.js', '.plugin.ts'],
+    'script': ['.script.js', '.script.ts'],
+    'material': ['.mat', '.mat.json'],
+    'image': ['.png', '.jpeg', '.jpg', '.gif', '.bmp', '.tiff', '.webp', '.hdr', '.exr', '.ktx2', '.svg'],
+    // 'texture': ['.png', '.jpeg', '.jpg', '.gif', '.bmp', '.tiff', '.webp', '.tex.json'],
+    // 'geometry': ['.glb', '.gltf', '.obj', '.fbx', '.ply', '.stl', '.geom.json'],
+    // 'object': ['.glb', '.gltf', '.obj', '.fbx', '.ply', '.stl', '.geom.json'],
+}
+export const mimeToExt: Record<string, string> = {
+    'image/jpeg': 'jpg',
+    'image/png': 'png',
+    'image/svg+xml': 'svg',
+    'image/webp': 'webp',
+    'image/x-exr': 'exr',
+    'image/x-hdr': 'hdr',
+    'model/gltf+binary': 'glb',
+    'model/gltf+json': 'gltf',
+    'model/gltf': 'gltf',
+}
+
+export const extensionMimeTypes: Record<string, string> = {
+    '.html': 'text/html; charset=utf-8',
+    '.css': 'text/css; charset=utf-8',
+    '.js': 'text/javascript; charset=utf-8',
+    '.mjs': 'text/javascript; charset=utf-8',
+    '.ts': 'text/typescript; charset=utf-8',
+    '.json': 'application/json; charset=utf-8',
+    '.gltf': 'model/gltf+json',
+    '.glb': 'model/gltf-binary',
+    '.png': 'image/png',
+    '.jpg': 'image/jpeg',
+    '.jpeg': 'image/jpeg',
+    '.gif': 'image/gif',
+    '.webp': 'image/webp',
+    '.svg': 'image/svg+xml',
+    '.wasm': 'application/wasm',
+    '.mp3': 'audio/mpeg',
+    '.ogg': 'audio/ogg',
+    '.wav': 'audio/wav',
+    '.mp4': 'video/mp4',
+    '.webm': 'video/webm',
+}
+
+export function mimeTypeForPath(path: string): string {
+    const lower = path.toLowerCase()
+    const extension = Object.keys(extensionMimeTypes)
+        .sort((a, b) => b.length - a.length)
+        .find((candidate) => lower.endsWith(candidate))
+    return extension ? extensionMimeTypes[extension] : 'application/octet-stream'
+}

package/src/importMap.ts

@@ -0,0 +1,105 @@
+import type {ProjectDependency} from './runtime/projectFormat.ts'
+
+export const RUNTIME_SPECIFIERS = [
+    'threepipe',
+    'three',
+    'uiconfig.js',
+    'ts-browser-helpers',
+    '@kite3d/engine',
+] as const
+
+export interface InstalledPluginImport {
+    specifier: string
+    entry: string
+    rootUrl: string
+}
+
+/** Create one safe import map for both editor play mode and published games. */
+export function dependencyImportMap(
+    dependencies: ProjectDependency[],
+    runtimeUrl = './_blitz/runtime.js',
+    installedPlugins: InstalledPluginImport[] = [],
+): {imports: Record<string, string>} {
+    const extras = uniqueDependencies(dependencies).filter(isMappableDependency)
+    const pluginSpecifiers = installedPlugins
+        .map(({specifier}) => specifier)
+        .filter((specifier) => !RUNTIME_SPECIFIERS.includes(specifier as typeof RUNTIME_SPECIFIERS[number]))
+    const externals = [...new Set([...RUNTIME_SPECIFIERS, ...extras.map(({key}) => key), ...pluginSpecifiers])]
+    const imports: Record<string, string> = Object.fromEntries(
+        RUNTIME_SPECIFIERS.map((specifier) => [specifier, runtimeUrl]),
+    )
+    for (const dependency of extras) {
+        const baseUrl = dependency.url || `https://esm.sh/${dependency.key}@${dependency.version}`
+        const separator = baseUrl.includes('?') ? '&' : '?'
+        imports[dependency.key] = `${baseUrl}${separator}external=${externals.join(',')}`
+    }
+    // Installed plugins map their bare name to the package entry and their trailing-slash name to the package root.
+    for (const plugin of installedPlugins) {
+        if (RUNTIME_SPECIFIERS.includes(plugin.specifier as typeof RUNTIME_SPECIFIERS[number])) continue
+        const rootUrl = plugin.rootUrl.endsWith('/') ? plugin.rootUrl : `${plugin.rootUrl}/`
+        imports[plugin.specifier] = `${rootUrl}${plugin.entry.replace(/^\.\//, '')}`
+        imports[`${plugin.specifier}/`] = rootUrl
+    }
+    return {imports}
+}
+
+/** Read dependency declarations without exposing package-manager-only specs. */
+export function projectDependencies(packageJson: Record<string, unknown>): ProjectDependency[] {
+    const result: ProjectDependency[] = []
+    const dependencies = packageJson.dependencies
+    if (isRecord(dependencies)) {
+        for (const [key, version] of Object.entries(dependencies)) {
+            if (typeof version === 'string') result.push({key, version})
+        }
+    }
+    const kite3d = packageJson.kite3d
+    const imports = isRecord(kite3d) ? kite3d.imports : undefined
+    if (isRecord(imports)) {
+        for (const [key, value] of Object.entries(imports)) {
+            if (typeof value !== 'string') continue
+            result.push(value.startsWith('@')
+                ? {key, version: value.slice(1)}
+                : {key, version: '', url: value})
+        }
+    }
+    return result
+}
+
+/** Return configured plugin names that are exact project dependency keys. */
+export function projectPluginNames(packageJson: Record<string, unknown>): string[] {
+    const dependencies = isRecord(packageJson.dependencies) ? packageJson.dependencies : {}
+    const kite3d = isRecord(packageJson.kite3d) ? packageJson.kite3d : {}
+    const plugins = Array.isArray(kite3d.plugins) ? kite3d.plugins : []
+    const names = plugins.flatMap((plugin) => {
+        const specifier = typeof plugin === 'string'
+            ? plugin.replace(/\(.*\)$/, '').trim()
+            : isRecord(plugin) && typeof plugin.import === 'string' ? plugin.import : ''
+        const matches = Object.keys(dependencies)
+            .filter((name) => specifier === name || specifier.startsWith(`${name}:`))
+            .sort((left, right) => right.length - left.length)
+        return matches.length ? [matches[0]] : []
+    })
+    return [...new Set(names)]
+}
+
+function uniqueDependencies(dependencies: ProjectDependency[]): ProjectDependency[] {
+    const byKey = new Map<string, ProjectDependency>()
+    for (const dependency of dependencies) {
+        if (!byKey.has(dependency.key)) byKey.set(dependency.key, dependency)
+    }
+    return [...byKey.values()]
+}
+
+function isMappableDependency(dependency: ProjectDependency): boolean {
+    if (RUNTIME_SPECIFIERS.includes(dependency.key as typeof RUNTIME_SPECIFIERS[number])) return false
+    if (dependency.key.startsWith('@kite3d/')) return false
+    return Boolean(dependency.url) || isSemverSpec(dependency.version)
+}
+
+function isSemverSpec(value: string): boolean {
+    return /^(?:[~^]|[<>]=?)?v?\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/.test(value.trim())
+}
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+    return Boolean(value) && typeof value === 'object' && !Array.isArray(value)
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+export * from './runtime/index.ts'
+export * from './scripts.ts'
+export * from './importMap.ts'
+export * from './defaults.ts'
+export * from './fileTypes.ts'
+export * from './paths.ts'
+export * from './sceneSerialization.ts'
+export * from './authoring.ts'
+export * from './authoringValidation.ts'
+export * from './plugins/HtmlUiComponent.ts'
+export * from './plugins/GeneratorComponent.ts'
+export * from './plugins/cannon/CannonPhysicsPlugin.ts'
+export * from './plugins/cannon/Cannon3DBodyComponent.ts'
+export * from './plugins/cannon/Cannon3DShapeComponent.ts'
+export * from './plugins/cannon/CannonRagdollComponent.ts'

package/src/paths.ts

@@ -0,0 +1,9 @@
+export const KITE3D_DIRECTORY = '.kite3d'
+export const DEPLOYS_PATH = `${KITE3D_DIRECTORY}/deploys.json`
+export const JOURNAL_PATH = `${KITE3D_DIRECTORY}/journal.jsonl`
+export const STATE_PATH = `${KITE3D_DIRECTORY}/state.json`
+export const CONSOLE_PATH = `${KITE3D_DIRECTORY}/console.log`
+export const THUMBS_DIRECTORY = `${KITE3D_DIRECTORY}/thumbs`
+export const BACKUPS_DIRECTORY = `${KITE3D_DIRECTORY}/backups`
+export const RUNNING_DIRECTORY = `${KITE3D_DIRECTORY}/running`
+export const KITE3D_SERVER_CLIENT_ID = 'kite3d-server'