Restored Import functionality for exported games

On UserInitialize, check to see if there is a project to be imported.

Added a new StartupPhaseResult enumeration. This can be used to determine if the next initialization phase should be run.

Load shortcuts and documentation after user initializiation.
The MainConfig data directory where they are loaded from can be modified by UserInitialize (e.g.: for imported games)

Author: jayrulez

Libraries/Core/Engine/Configuration.cpp

@@ -432,12 +432,14 @@ Cog* LoadConfig(ModifyConfigFn modifier, void* userData)
     return nullptr;
   }
 
-  modifier(configCog, userData);
-
   MainConfig* mainConfig = HasOrAdd<MainConfig>(configCog);
   mainConfig->SourceDirectory = sourceDirectory;
   mainConfig->DataDirectory = dataDirectory;
 
+  // Modifier can modify MainConfig on configCog
+  // so let it run after setting source and data dirs
+  modifier(configCog, userData);
+
   Z::gEngine->mConfigCog = configCog;
 
   SaveConfig();

Libraries/Projects/Startup/Startup.cpp

@@ -19,8 +19,9 @@ void ZeroStartup::UserInitializeConfig(Cog* configCog)
 {
 }
 
-void ZeroStartup::UserInitialize()
+StartupPhaseResult::Enum ZeroStartup::UserInitialize()
 {
+  return StartupPhaseResult::Continue;
 }
 
 void ZeroStartup::UserStartup()
@@ -48,15 +49,27 @@ void ZeroStartup::Exit(int returnCode)
 
 void ZeroStartup::MainLoop()
 {
+  StartupPhaseResult::Enum result = StartupPhaseResult::Continue;
   switch (mPhase)
   {
   case StartupPhase::Initialize:
     Initialize();
     NextPhase();
     break;
   case StartupPhase::UserInitialize:
-    UserInitialize();
-    NextPhase();
+    result = UserInitialize();
+    if (result == StartupPhaseResult::Continue)
+    {
+      Shortcuts::GetInstance()->Load(
+          FilePath::Combine(Z::gEngine->GetConfigCog()->has(MainConfig)->DataDirectory, "Shortcuts.data"));
+
+      // Load documentation for all native libraries
+      DocumentationLibrary::GetInstance()->LoadDocumentation(
+          FilePath::Combine(Z::gEngine->GetConfigCog()->has(MainConfig)->DataDirectory, "Documentation.data"));
+      NextPhase();
+    }
+    else
+      mPhase = StartupPhase::Shutdown;
     break;
   case StartupPhase::Startup:
     Startup();
@@ -88,6 +101,9 @@ void ZeroStartup::MainLoop()
     break;
   case StartupPhase::Shutdown:
     Shutdown();
+    // Exit could still be false UserInitialize goes straight to shutdown
+    // consider refactoring
+    mExit = true;
     break;
   }
 
@@ -221,12 +237,12 @@ void ZeroStartup::Initialize()
 
   Tweakables::Load();
 
-  Shortcuts::GetInstance()->Load(
-      FilePath::Combine(Z::gEngine->GetConfigCog()->has(MainConfig)->DataDirectory, "Shortcuts.data"));
+  //Shortcuts::GetInstance()->Load(
+  //    FilePath::Combine(Z::gEngine->GetConfigCog()->has(MainConfig)->DataDirectory, "Shortcuts.data"));
 
-  // Load documentation for all native libraries
-  DocumentationLibrary::GetInstance()->LoadDocumentation(
-      FilePath::Combine(Z::gEngine->GetConfigCog()->has(MainConfig)->DataDirectory, "Documentation.data"));
+  //// Load documentation for all native libraries
+  //DocumentationLibrary::GetInstance()->LoadDocumentation(
+  //    FilePath::Combine(Z::gEngine->GetConfigCog()->has(MainConfig)->DataDirectory, "Documentation.data"));
 
   ZPrint("Os: %s\n", Os::GetVersionString().c_str());
 }

Libraries/Projects/Startup/Startup.hpp

@@ -32,6 +32,13 @@ DeclareEnum10(
     // All libraries are shutdown and the engine is destroyed.
     Shutdown);
 
+// Determine whether to continue to next startup phase or not
+DeclareEnum2(StartupPhaseResult,
+    // Continue to the next phase
+    Continue,
+    // Do not continue to the next phase
+    Quit);
+
 // Runs through phases of initialization, allowing platforms that don't support threading
 // to yeild time back to the OS/Browser between updates. This also unifies Editor/Game/Launcher startup.
 class ZeroStartup
@@ -71,7 +78,7 @@ class ZeroStartup
   // The order these are declared is the order they will be called.
   virtual void UserInitializeLibraries();
   virtual void UserInitializeConfig(Cog* configCog);
-  virtual void UserInitialize();
+  virtual StartupPhaseResult::Enum UserInitialize();
   virtual void UserStartup();
   virtual void UserCreation();
   virtual void UserShutdown();

Libraries/Projects/WelderEditor/GameOrEditorStartup.cpp

@@ -13,14 +13,25 @@ void GameOrEditorStartup::UserInitializeConfig(Cog* configCog)
   HasOrAdd<EditorSettings>(configCog);
   HasOrAdd<ContentConfig>(configCog);
   HasOrAdd<TextEditorConfig>(configCog);
+  MainConfig* mainConfig = configCog->has(MainConfig);
+  if (mainConfig && mEmbeddedPackage)
+  {
+    static const String cDataDirectoryName("Data");
+    mainConfig->DataDirectory = FilePath::Combine(mEmbeddedOutputDirectory, cDataDirectoryName);
+  }
 }
 
-void GameOrEditorStartup::UserInitialize()
+StartupPhaseResult::Enum GameOrEditorStartup::UserInitialize()
 {
   String projectFile = Environment::GetValue<String>("file");
   bool playGame = Environment::GetValue<bool>("play", false);
   String newProject = Environment::GetValue<String>("newProject");
 
+  Importer importer;
+  ImporterResult::Type importResult = importer.CheckForImport();
+  if (importResult == ImporterResult::ExecutedAnotherProcess)
+    return StartupPhaseResult::Quit;
+
   // Check to see if there was a project file in the same directory.
   static const String cDefaultProjectFile("Project.zeroproj");
   if (FileExists(cDefaultProjectFile))
@@ -29,6 +40,15 @@ void GameOrEditorStartup::UserInitialize()
     playGame = true;
   }
 
+  // Fix the project file path for exports to be in the import's output directory
+  mEmbeddedPackage = (importResult == ImporterResult::Embeded);
+  if (mEmbeddedPackage)
+  {
+    mEmbeddedOutputDirectory = importer.mOutputDirectory;
+    projectFile = FilePath::Combine(mEmbeddedOutputDirectory, "Project.zeroproj");
+    playGame = true;
+  }
+
   // If there was no specified project file (or it doesn't exist) and we're not
   // creating a new project, then use a fall-back project that we open from our
   // data directory. This project should be read-only, but is useful for testing
@@ -54,7 +74,8 @@ void GameOrEditorStartup::UserInitialize()
     if (projectCog == nullptr)
     {
       FatalEngineError("Failed load project '%s'", projectFile.c_str());
-      return Exit(1);
+      Exit(1);
+      return StartupPhaseResult::Continue;
     }
 
     // Since we don't create a resiziable wigdet/close button, etc.
@@ -70,6 +91,8 @@ void GameOrEditorStartup::UserInitialize()
   mProjectCog = projectCog;
   mProjectFile = projectFile;
   mNewProject = newProject;
+
+  return StartupPhaseResult::Continue;
 }
 
 void GameOrEditorStartup::UserStartup()

Libraries/Projects/WelderEditor/GameOrEditorStartup.hpp

@@ -11,9 +11,11 @@ class GameOrEditorStartup : public ZeroStartup
   Cog* mProjectCog = nullptr;
   String mProjectFile;
   String mNewProject;
+  bool mEmbeddedPackage = false;
+  String mEmbeddedOutputDirectory;
 
   void UserInitializeConfig(Cog* configCog) override;
-  void UserInitialize() override;
+  StartupPhaseResult::Enum UserInitialize() override;
   void UserStartup() override;
   void UserCreation() override;
 };

Libraries/Projects/WelderLauncher/LauncherStartup.cpp

@@ -23,7 +23,7 @@ void LauncherStartup::UserInitializeConfig(Cog* configCog)
   versionConfig->ApplyCommandLineArguments();
 }
 
-void LauncherStartup::UserInitialize()
+StartupPhaseResult::Enum LauncherStartup::UserInitialize()
 {
   // Check and see if another launcher is already open (has to happen after
   // startup)
@@ -36,7 +36,8 @@ void LauncherStartup::UserInitialize()
     ZPrint("Mutex is already open. Sending a message to the open launcher and "
            "closing\n");
     Zero::LauncherSingletonCommunication communicator;
-    return Exit(0);
+    Exit(0);
+    return StartupPhaseResult::Continue;
   }
 
   CrashHandler::SetRestartCommandLine(Environment::GetInstance()->mCommandLine);
@@ -45,6 +46,8 @@ void LauncherStartup::UserInitialize()
   mMinimumWindowSize = IntVec2(1024, 595);
   mWindowCentered = true;
   mWindowState = WindowState::Windowed;
+
+  return StartupPhaseResult::Continue;
 }
 
 void LauncherStartup::UserStartup()

Libraries/Projects/WelderLauncher/LauncherStartup.hpp

@@ -9,7 +9,7 @@ class LauncherStartup : public ZeroStartup
 protected:
   void UserInitializeLibraries() override;
   void UserInitializeConfig(Cog* configCog) override;
-  void UserInitialize() override;
+  StartupPhaseResult::Enum UserInitialize() override;
   void UserStartup() override;
   void UserCreation() override;
   void UserShutdown() override;