feat: improve new_project.py to not require pl-build

Author: hoffstadt

.github/workflows/build.yml

@@ -46,7 +46,7 @@ jobs:
         Invoke-WebRequest -Uri "https://sdk.lunarg.com/sdk/download/1.4.350.0/windows/vulkansdk-windows-X64-1.4.350.0.exe" -OutFile VulkanSDK.exe
         # ./VulkanSDK.exe --help
         ./VulkanSDK.exe --accept-licenses --default-answer --root D:/a/VulkanSDK --confirm-command install
-        python3 -m pip install pl-build
+        python3 -m pip install pl-build 
 
     - name: Prep 1
       shell: cmd
@@ -183,7 +183,7 @@ jobs:
         curl https://sdk.lunarg.com/sdk/download/1.4.350.0/mac/vulkansdk-macos-1.4.350.0.zip -o vk.zip
         unzip vk.zip
         sudo ./vulkansdk-macOS-1.4.350.0.app/Contents/MacOS/vulkansdk-macOS-1.4.350.0 --root ~/VulkanSDK/1.4.350.0 --accept-licenses --default-answer --confirm-command install com.lunarg.vulkan.core com.lunarg.vulkan.usr com.lunarg.vulkan.sdl2 com.lunarg.vulkan.glm com.lunarg.vulkan.volk com.lunarg.vulkan.vma com.lunarg.vulkan.ios
-        python3 -m pip install pl-build
+        python3 -m pip install pl-build 
 
     - name: Prep 1
       run: |
@@ -322,7 +322,7 @@ jobs:
         sudo apt install libxinerama-dev
         sudo apt install libgl-dev
         sudo apt install libxi-dev
-        python3 -m pip install pl-build
+        python3 -m pip install pl-build 
 
     - name: Prep 1
       run: |

README.md

@@ -54,7 +54,6 @@ The fastest way to use Pilot Light is to generate a small standalone project.
 From the root of this repository:
 
 ```bash
-python -m pip install pl-build
 python scripts/new_project.py ../MyFirstProject
 ```
 Then just run your platforms build script located in the **/src** directory of your new project. The binaries will be located in the **/out** directory. The Pilot Light directory is no longer needed. Running the script again will update your project with the newest Pilot Light files.

internal/templates/gen_build_c.py

@@ -19,10 +19,20 @@
 import sys
 import platform as plat
 
-import pl_build.core as pl
-import pl_build.backend_win32 as win32
-import pl_build.backend_linux as linux
-import pl_build.backend_macos as apple
+try:
+    import pl_build.core as pl
+    import pl_build.backend_win32 as win32
+    import pl_build.backend_linux as linux
+    import pl_build.backend_macos as apple
+except ImportError:
+    # just use the packaged build so users don't need to pip install pl-build
+    if len(sys.argv) > 1:
+        sys.path.insert(0, sys.argv[1])
+    import build.core as pl
+    import build.backend_win32 as win32
+    import build.backend_linux as linux
+    import build.backend_macos as apple
+
 
 #-----------------------------------------------------------------------------
 # [SECTION] project

internal/templates/gen_build_c_api.py

@@ -19,10 +19,19 @@
 import sys
 import platform as plat
 
-import pl_build.core as pl
-import pl_build.backend_win32 as win32
-import pl_build.backend_linux as linux
-import pl_build.backend_macos as apple
+try:
+    import pl_build.core as pl
+    import pl_build.backend_win32 as win32
+    import pl_build.backend_linux as linux
+    import pl_build.backend_macos as apple
+except ImportError:
+    # just use the packaged build so users don't need to pip install pl-build
+    if len(sys.argv) > 1:
+        sys.path.insert(0, sys.argv[1])
+    import build.core as pl
+    import build.backend_win32 as win32
+    import build.backend_linux as linux
+    import build.backend_macos as apple
 
 #-----------------------------------------------------------------------------
 # [SECTION] project

internal/templates/gen_build_cpp.py

@@ -23,10 +23,19 @@
 import sys
 import platform as plat
 
-import pl_build.core as pl
-import pl_build.backend_win32 as win32
-import pl_build.backend_linux as linux
-import pl_build.backend_macos as apple
+try:
+    import pl_build.core as pl
+    import pl_build.backend_win32 as win32
+    import pl_build.backend_linux as linux
+    import pl_build.backend_macos as apple
+except ImportError:
+    # just use the packaged build so users don't need to pip install pl-build
+    if len(sys.argv) > 1:
+        sys.path.insert(0, sys.argv[1])
+    import build.core as pl
+    import build.backend_win32 as win32
+    import build.backend_linux as linux
+    import build.backend_macos as apple
 
 #-----------------------------------------------------------------------------
 # [SECTION] project

internal/templates/gen_build_cpp_api.py

@@ -23,10 +23,19 @@
 import sys
 import platform as plat
 
-import pl_build.core as pl
-import pl_build.backend_win32 as win32
-import pl_build.backend_linux as linux
-import pl_build.backend_macos as apple
+try:
+    import pl_build.core as pl
+    import pl_build.backend_win32 as win32
+    import pl_build.backend_linux as linux
+    import pl_build.backend_macos as apple
+except ImportError:
+    # just use the packaged build so users don't need to pip install pl-build
+    if len(sys.argv) > 1:
+        sys.path.insert(0, sys.argv[1])
+    import build.core as pl
+    import build.backend_win32 as win32
+    import build.backend_linux as linux
+    import build.backend_macos as apple
 
 #-----------------------------------------------------------------------------
 # [SECTION] project

scripts/new_project.py

@@ -16,6 +16,7 @@
 
 target_directory = "../../project"
 file_directory = os.path.dirname(os.path.abspath(__file__))
+build_sys_directory = os.path.dirname(os.path.abspath(__file__)) + "/.."
 
 cpp = False
 api = False
@@ -35,7 +36,11 @@
 if os.path.isdir(target_directory + "/dependencies"):
     newProject = False
     print("Updating Existing Project")
-    shutil.rmtree(target_directory + "/dependencies")
+    shutil.rmtree(target_directory + "/dependencies/pilotlight")
+    shutil.rmtree(target_directory + "/dependencies/cgltf")
+    shutil.rmtree(target_directory + "/dependencies/glfw")
+    shutil.rmtree(target_directory + "/dependencies/imgui")
+    shutil.rmtree(target_directory + "/dependencies/stb")
 
 if not os.path.isdir(target_directory):
     os.mkdir(target_directory)
@@ -45,13 +50,12 @@
     os.mkdir(target_directory + "/docs")
     os.mkdir(target_directory + "/tests")
     os.mkdir(target_directory + "/.vscode")
+    os.mkdir(target_directory + "/dependencies")
 
-os.mkdir(target_directory + "/dependencies")
 os.mkdir(target_directory + "/dependencies/pilotlight")
 os.mkdir(target_directory + "/dependencies/pilotlight/include")
 os.mkdir(target_directory + "/dependencies/pilotlight/src")
 
-
 for file in glob.glob(file_directory + "/../extensions/pl_*_ext.h"):
     shutil.copy(file, target_directory + "/dependencies/pilotlight/include/")
 
@@ -87,19 +91,28 @@
 shutil.copytree(file_directory + "/../thirdparty/stb", target_directory + "/dependencies/stb")
 shutil.copytree(file_directory + "/../shaders", target_directory + "/dependencies/pilotlight/shaders")
 
+if cpp and api:
+    shutil.copy(file_directory + "/../internal/templates/gen_build_cpp_api.py", target_directory + "/scripts/gen_build.py")
+elif api:
+    shutil.copy(file_directory + "/../internal/templates/gen_build_c_api.py", target_directory + "/scripts/gen_build.py")
+elif cpp:
+    shutil.copy(file_directory + "/../internal/templates/gen_build_cpp.py", target_directory + "/scripts/gen_build.py")
+else:
+    shutil.copy(file_directory + "/../internal/templates/gen_build_c.py", target_directory + "/scripts/gen_build.py")
+
 if newProject:
     print("Generating New Project")
     if cpp and api:
-        shutil.copy(file_directory + "/../internal/templates/gen_build_cpp_api.py", target_directory + "/scripts/gen_build.py")
+        shutil.copy(file_directory + "/../internal/templates/gen_build_cpp_api.py", target_directory + "/scripts/gen_build_user.py")
         shutil.copy(file_directory + "/../internal/templates/template_app_api.cpp", target_directory + "/src/app.cpp")
     elif api:
-        shutil.copy(file_directory + "/../internal/templates/gen_build_c_api.py", target_directory + "/scripts/gen_build.py")
+        shutil.copy(file_directory + "/../internal/templates/gen_build_c_api.py", target_directory + "/scripts/gen_build_user.py")
         shutil.copy(file_directory + "/../internal/templates/template_app_api.cpp", target_directory + "/src/app.c")
     elif cpp:
-        shutil.copy(file_directory + "/../internal/templates/gen_build_cpp.py", target_directory + "/scripts/gen_build.py")
+        shutil.copy(file_directory + "/../internal/templates/gen_build_cpp.py", target_directory + "/scripts/gen_build_user.py")
         shutil.copy(file_directory + "/../internal/templates/template_app.cpp", target_directory + "/src/app.cpp")
     else:
-        shutil.copy(file_directory + "/../internal/templates/gen_build_c.py", target_directory + "/scripts/gen_build.py")
+        shutil.copy(file_directory + "/../internal/templates/gen_build_c.py", target_directory + "/scripts/gen_build_user.py")
         shutil.copy(file_directory + "/../internal/templates/template_app.cpp", target_directory + "/src/app.c")
 
     shutil.copy(file_directory + "/../src/pl_config.h", target_directory + "/src/pl_config.h")
@@ -114,7 +127,7 @@
 
     os.chdir(target_directory)
     os.chdir("scripts")
-    subprocess.run([os.path.basename(sys.executable), "gen_build.py"])
+    subprocess.run([os.path.basename(sys.executable), "gen_build.py", build_sys_directory])
 
 else:
     if(os.path.isdir(target_directory + "/out")):
@@ -125,5 +138,5 @@
         shutil.rmtree(target_directory + "/cache")
     os.chdir(target_directory)
     os.chdir("scripts")
-    subprocess.run([os.path.basename(sys.executable), "gen_build.py"])
+    subprocess.run([os.path.basename(sys.executable), "gen_build.py", build_sys_directory])