Pipeline: encapsulate platform dependent prepare code

matthewcpp · matthewcpp · commit 2166fe7ddbcb · 2024-12-01T09:52:01.000-08:00
diff --git a/pipeline/Pipeline.js b/pipeline/Pipeline.js
@@ -1,8 +1,6 @@
 #!/usr/bin/env node
 
 const Util = require("./Util");
-// TODO: this needs to be moved into desktop
-const prepareDesktopShaders = require("../scripts/PrepareDesktopShaders");
 
 const { program } = require('commander');
 const rimraf = require("rimraf");
@@ -16,12 +14,13 @@ const path = require("path");
  * @param assetDirectory the root path of the folder containing all assets
  * @param platform the platform that is currently being built
  * @param platformBuildDirectory the root build directory for this platform
- * @param gameBuildDirectory the path to the directory where all compiled code will be built to
- * @param gameBinDirectory the output directory for this game's binary files
+ * @param outputDirectory the output directory for this game's assets
  * @param pluginManifest the path pointing to the plugin manifest for this build
  */
-async function prepareAssets(manifestFile, assetDirectory, platform, gameBuildDirectory, gameBinDirectory, pluginManifest) {
-    const outputDirectory = path.join(gameBinDirectory, "assets");
+async function prepareAssets(manifestFile, assetDirectory, platform, outputDirectory, pluginManifest) {
+    if (!fse.existsSync(manifestFile)) {
+        throw new Error(`Manifest file does not exist: ${manifestFile}`);
+    }
 
     if (fse.existsSync(outputDirectory)) {
         rimraf.sync(outputDirectory);
@@ -37,37 +36,19 @@ async function prepareAssets(manifestFile, assetDirectory, platform, gameBuildDi
 
     switch (platform) {
         case "n64_libultra":
-            purgeCompiledAssetData(gameBuildDirectory)
+            //purgeCompiledAssetData(gameBuildDirectory)
             const processN64 = require("./n64_libultra/Process");
             await processN64(manifestFile, assetDirectory, outputDirectory, pluginMap);
-            break;
+        break;
 
         case "desktop":
             const processDesktop = require("./desktop/Process");
             await processDesktop(manifestFile, assetDirectory, outputDirectory, pluginMap);
-            
-            /// TODO: This should be moved into the desktop processing directory
-            const shaderDestDir = path.join(gameBinDirectory, "glsl");
-            prepareDesktopShaders(shaderDestDir);
-            break;
+        break;
 
         default:
-            throw new Error(`Unsupported platform: ${manifest.platform}`);
-    }
-}
-
-/** 
- * This function is needed because the compiler will need to regenerate the packed asset data when there is a change.
- * TODO: this should be moved into n64_libulta directory
-*/
-function purgeCompiledAssetData(gameBuildDirectory){
-    const compiledDataPath = path.join(gameBuildDirectory, "asm", "asset_data.s.obj");
-
-    if (fse.existsSync(compiledDataPath)) {
-        console.log(`Purging compiled asset data file: ${compiledDataPath}`);
-        fse.unlinkSync(compiledDataPath)
+            throw new Error(`Unsupported platform: ${platform}`);
     }
-    
 }
 
 function loadPlugins(pluginManifestPath) {
@@ -130,9 +111,4 @@ function loadPlugins(pluginManifestPath) {
 
 module.exports = {
     prepareAssets: prepareAssets
-};
-
-if (require.main === module) {
-    require("../scripts/RunPipeline")();
-    main();
-}
+};
diff --git a/scripts/PrepareBuiltinAssets.js b/scripts/PrepareBuiltinAssets.js
@@ -1,4 +1,5 @@
 const Pipeline = require("../pipeline/Pipeline");
+const preparePlatform = require("./PreparePlatform");
 
 const path = require("path");
 const fse = require("fs-extra");
@@ -27,9 +28,12 @@ async function prepreBuiltinAssets(folder, name, platform) {
 
     const gameBinDirectory = path.join(platformBuildDir,  "bin", name);
     const gameBuildDirectory = path.join(platformBuildDir, folder, name, "CMakeFiles", `${name}.dir`);
+    const outputDirectory = path.join(gameBinDirectory, "assets");
 
     const pluginManifestPath = path.join(targetDirectory, "pipeline", "plugins.json");
-    await Pipeline.prepareAssets(manifestFile, assetDirectory, platform, gameBuildDirectory, gameBinDirectory, fse.existsSync(pluginManifestPath) ? pluginManifestPath: null);
+
+    preparePlatform(platform, gameBuildDirectory, gameBinDirectory);
+    await Pipeline.prepareAssets(manifestFile, assetDirectory, platform, outputDirectory, fse.existsSync(pluginManifestPath) ? pluginManifestPath: null);
 }
 
 async function prepareAllBuiltinAssets(topLevelDir, platform) {
diff --git a/scripts/PrepareDesktopShaders.js b/scripts/PrepareDesktopShaders.js
diff --git a/scripts/PrepareGameAssets.js b/scripts/PrepareGameAssets.js
@@ -1,4 +1,5 @@
 const Pipeline = require("../pipeline/Pipeline");
+const preparePlatform = require("./PreparePlatform");
 
 const { program } = require("commander");
 const fse = require("fs-extra");
@@ -25,6 +26,7 @@ async function prepareGameAssets(platform, target) {
 
     const gameBinDirectory = path.join(platformBuildDir,  "bin", target);
     const gameBuildDirectory = path.join(platformBuildDir, "src", "CMakeFiles", `${target}.dir`);
+    const outputDirectory = path.join(gameBinDirectory, "assets");
     const pluginManifestPath = path.join(gameDirectory, "pipeline", "plugins.json");
 
     // read game name from package manifest if not specified
@@ -35,6 +37,7 @@ async function prepareGameAssets(platform, target) {
         console.log(`No target specified. using default target: ${packageJson.name}`);
     }
 
-    await Pipeline.prepareAssets(assetManifest, assetDirectory, platform, gameBuildDirectory, gameBinDirectory, fse.existsSync(pluginManifestPath) ? pluginManifestPath: null);
+    preparePlatform(platform, gameBuildDirectory, gameBinDirectory);
+    await Pipeline.prepareAssets(assetManifest, assetDirectory, platform, outputDirectory, fse.existsSync(pluginManifestPath) ? pluginManifestPath: null);
 }
 
diff --git a/scripts/PreparePlatform.js b/scripts/PreparePlatform.js
@@ -0,0 +1,46 @@
+const fse = require("fs-extra");
+const path = require("path");
+
+/**
+ * @param platform the platform that is currently being built
+ * @param gameBuildDirectory the path to the directory where all compiled code will be built to
+ * @param gameBinDirectory the output directory for this game's binary files
+ */
+function preparePlatform(platform, gameBuildDirectory, gameBinDirectory) {
+    switch(platform) {
+        case "desktop":
+            const shaderDestDir = path.join(gameBinDirectory, "glsl");
+            prepareDesktopShaders(shaderDestDir);
+        break;
+
+        case "n64_libultra":
+            purgeCompiledAssetData(gameBuildDirectory);
+        break;
+    }
+}
+
+async function prepareDesktopShaders(destDir) {
+    console.log("Preparing Desktop Shaders");
+    const shaderDir = path.resolve(__dirname, "..", "src", "framework64", "desktop", "glsl");
+
+    if (!fse.existsSync(shaderDir)) {
+        throw new Error(`Unable to locate shader directory: ${shaderDir}`);
+    }
+
+    await fse.ensureDir(destDir);
+
+    console.log(`Copy: ${shaderDir} -> ${destDir}`);
+    fse.copySync(shaderDir, destDir);
+}
+
+/** This function is needed because the compiler will need to regenerate the packed asset data when there is a change. */
+function purgeCompiledAssetData(gameBuildDirectory){
+    const compiledDataPath = path.join(gameBuildDirectory, "asm", "asset_data.s.obj");
+
+    if (fse.existsSync(compiledDataPath)) {
+        console.log(`Purging compiled asset data file: ${compiledDataPath}`);
+        fse.unlinkSync(compiledDataPath)
+    }
+}
+
+module.exports = preparePlatform;
diff --git a/scripts/RunPipeline.js b/scripts/RunPipeline.js
@@ -0,0 +1,42 @@
+/* This is a generic script that external clients can use to run the asset pipeline.
+   It is currently used by the data link asset service to convert assets on the fly.
+*/
+const Pipeline = require("../pipeline/Pipeline");
+
+const { program } = require("commander");
+
+const fse = require("fs-extra");
+
+program
+    .name("Prepare Assets")
+    .version("1.0.0")
+    .description("Prepare framework64 Assets");
+
+program
+    .argument("<platform>")
+    .argument("<assetManifestFile>")
+    .argument("<assetDirectory>")
+    .argument("<outputDirectory>")
+    .action(runPipeline);
+
+program.parse();
+
+async function runPipeline(platform, assetManifestFile, assetDirectory, outputDirectory) {
+    if (!fse.existsSync(assetManifestFile)) {
+        console.log(`manifest file: ${assetManifestFile} does not exist.`);
+        process.exit(1);
+    }
+
+    if (!fse.existsSync(assetDirectory)) {
+        console.log(`Asset directory: ${assetDirectory} does not exist.`);
+        process.exit(1);
+    }
+
+    console.log("Running framework64 Asset Pipeline");
+    console.log(`    Platform: ${platform}`);
+    console.log(`    Manifest File: ${assetManifestFile}`);
+    console.log(`    Asset Directory: ${assetDirectory}`);
+    console.log(`    Output Directory: ${outputDirectory}`);
+
+    await Pipeline.prepareAssets(assetManifestFile, assetDirectory, platform, outputDirectory, null);
+}
diff --git a/tools/blender_plugin/framework64_plugin.py b/tools/blender_plugin/framework64_plugin.py
@@ -9,7 +9,7 @@
 
 bl_info = {
     "name": "framework64",
-    "description": "Live in-engine preview",
+    "description": "Plugin for creating games with framework64",
     "author": "Matthew LaRocca",
     "version": (0, 1),
     "blender": (2, 80, 0),
@@ -37,15 +37,11 @@ def send_static_mesh_to_console(self):
 
     @staticmethod
     def webservice_data_transfer(asset_path, temp_dir):
-        if sys.platform == "win32":
-            endpoint_uri = "http://localhost:55660/static-mesh"
-        else:
-            endpoint_uri = "http://0.0.0.0:55660/static-mesh"
-
+        endpoint_uri = "http://127.0.0.1:62187"
         print("Transfer static mesh: {} --> {}".format(asset_path, endpoint_uri))
 
         try:
-            r = requests.post(endpoint_uri, data=json.dumps({"src": asset_path}))
+            r = requests.post(endpoint_uri, data=json.dumps({"type":"mesh", "src": asset_path}))
             r.raise_for_status()
         except requests.exceptions.RequestException as e:
             print("Transfer failed: {}".format(e))
diff --git a/tools/data_link_asset_viewer/asset_viewer.h b/tools/data_link_asset_viewer/asset_viewer.h
@@ -9,7 +9,6 @@ typedef struct {
     fw64Engine* engine;
     fw64Font* font;
     fw64RenderPass* renderpass;
-    fw64SpriteBatch* spritebatch;
     fw64AssetViewer asset_viewer;
     fw64FileDownloader file_downloader;
 } Game;
diff --git a/tools/data_link_client/example/example_client.cpp b/tools/data_link_client/example/example_client.cpp
@@ -25,7 +25,7 @@ int main(int argc, char** argv) {
     Settings settings;
     
     auto* n64_command = app.add_subcommand("n64", "connect to n64 example");
-    n64_command->add_option("ROM Path", settings.n64_rom_path, "Path to data_link rom that will be loaded on N64");
+    n64_command->add_option("--rom", settings.n64_rom_path, "Path to data_link rom that will be loaded on N64");
     n64_command->callback([&settings](){ settings.platform = Platform::N64; });
 
     auto* desktop_command = app.add_subcommand("desktop", "transfer assets to Desktop");
