Better project structure

Dependencies/glfw/premake5.lua

@@ -17,8 +17,16 @@ project "glfw"
 		"include"
 	}
 
-	filter { "system:window" }
+	filter { "system:windows" }
 		defines { "_GLFW_WIN32" }
+		removefiles {
+			"src/cocoa_*",
+			"src/posix_time.h",
+			"src/x11_*",
+			"src/glx_*",
+			"src/nsgl_*"
+		}
+	filter {}
 
 	filter { "system:linux" }
 		defines { "_GLFW_X11", "_GNU_SOURCE" }
@@ -29,7 +37,7 @@ project "glfw"
 			"src/wgl_*",
 				"src/nsgl_*"
 		}
-
+	filter {}
 
 	filter { "configurations:Debug" }
 		defines { "DEBUG" }

Dependencies/tracy/premake5.lua

@@ -13,6 +13,11 @@ project "tracy"
 		"**.cpp",
 		"**.lua"
 	}
+
+	-- Not needed on Windows
+	filter { "system:windows" }
+		removefiles { "libbacktrace/**" }
+	filter {}
 
 	filter { "configurations:Debug" }
 		defines { "DEBUG" }

README.md

@@ -51,18 +51,48 @@ Overload pillars are:
 
 Check out our [issues](https://github.com/Overload-Technologies/Overload/issues) and [pull requests](https://github.com/Overload-Technologies/Overload/pulls) to learn more about what's coming next!
 
-# Quick Start (TL;DR)
-*Assuming you are on Windows, have Visual Studio 2022 installed, and have about 5 minutes to spare!*
-1. Clone Overload
-2. Inside of the repository folder, run `OpenInVisualStudio.bat`
-3. Build the project, voilà!
+# Documentation
+Check-out Overload's [documentation](https://github.com/Overload-Technologies/Overload/wiki) to find **sample projects**, **tutorials** & the **scripting API**!
 
-- **⭐ Bonus:** get one of Overload's [sample projects](https://github.com/Overload-Technologies/Overload/wiki/Sample-Projects)!
-- **✨ Extra Bonus:** check-out the [documentation](https://github.com/Overload-Technologies/Overload/wiki).
+# Getting Started
 
-More in-depth guide on getting started available [here](#getting-started).
+Before running Overload, we highly recommend [downloading one of Overload's sample projects](https://github.com/Overload-Technologies/Overload/wiki/Sample-Projects)!
 
+## Pre-Built Binaries
 In a rush? [Get the latest release](https://github.com/Overload-Technologies/Overload/releases)!
+> [!warning] Pre-built binaries are only available for Windows at the moment.
+
+## Building From Sources
+### Windows (MSVC)
+```powershell
+git clone https://github.com/Overload-Technologies/Overload
+cd Overload
+.\gen_proj_win32.bat # generate project files for Visual Studio 2022
+
+# (Optional) open the solution in Visual Studio
+.\Overload.sln
+```
+
+### Linux (Clang)
+```bash
+git clone https://github.com/Overload-Technologies/Overload
+cd Overload
+./gen_proj_linux.sh # generate Makefiles
+
+# (Optional) build the project
+make
+```
+
+### Other Platforms & IDEs
+`gen_proj` scripts can be invoked with an argument to specify the the action to perform.
+```bash
+# Generating Makefile on Windows
+.\gen_proj_win32.bat gmake
+
+# Generating CodeLite project on Linux
+./gen_proj_linux.sh codelite
+``` 
+*Please refer to [Premake5's documentation](https://premake.github.io/docs/Using-Premake) to find supported IDEs.*
 
 # Architecture
 Overload is divided into 11 modules: 9 libraries (SDK), and 2 executables (Applications).
@@ -99,51 +129,6 @@ Overload depends on a few third-party libraries:
 - [ImGui](https://github.com/ocornut/imgui) (GUI)
 - [Premake5](https://github.com/premake/premake-core) (Project generation)
 
-# Getting started
-## Running Overload from a Release Build
-Get started with Overload in no time by downloading one of our [release builds](https://github.com/Overload-Technologies/Overload/releases). While this is the fastest way to get started, you might miss out on some cool features we're cooking up!
-
-After downloading the archive, unzip it and run the `Overload.exe` executable file.
-
-## Building Overload from Sources
-
-### Quick Start (For Visual Studio 2022)
-To start working with Overload quickly, clone the repository and run the `OpenInVisualStudio.bat` script. Project files will be automatically generated, and Visual Studio will open with the generated solution (`Overload/Sources/Overload.sln`).
-
-```powershell
-# These 2 lines will clone Overload, generate project files, and open the Visual Studio solution.
-git clone https://github.com/Overload-Technologies/Overload
-.\Overload\OpenInVisualStudio.bat
-```
-
-### Generating Project Files (For Any IDE)
-*Note: This step is performed automatically when using `OpenInVisualStudio.bat`*
-
-Overload uses Premake5 to generate project files. To generate these files, execute the `GenerateProjects.bat` located in the `Scripts/` folder.
-
-By default, `GenerateProjects.bat` will generate project files for Visual Studio 2022.
-
-If you'd like to use another IDE, you'll need to run `GenerateProjects.bat` from the command line:
-
-```powershell
-.\Scripts\GenerateProjects.bat <ide_of_your_choice>
-```
-
-*Please refer to [Premake5's documentation](https://premake.github.io/docs/Using-Premake) to find supported IDEs.*
-
-> ⚠️ Some Premake5-supported IDEs might still not work with Overload.
-
-### Building From the Command Line (MSVC Only)
-*Note: Before building, make sure that you generated the Visual Studio solution.*
-
-If you'd like to build Overload directly from the command line (without opening Visual Studio), you can use the `BuildAll.bat` script located in `Scripts/MSVC/`. By default, `BuildAll.bat` will build the project in `Debug` mode, but you can choose the configuration you want by providing an argument:
-```powershell
-.\Scripts\MSVC\BuildAll.bat Release
-```
-
-## Tutorials & Scripting API
-Learn how to create your own games using Overload by visiting our [wiki](https://github.com/Overload-Technologies/Overload/wiki).
-
 # Contributing
 Overload is open to contributions of all kinds. Feel free to open issues (feature requests or bug reports) or submit pull requests.
 
@@ -153,9 +138,9 @@ If you'd like to contribute, please refer to our [contribution guildelines](http
 | | |
 |-|-|
 | **RAM** | 1GB |
-| **OS**  | Windows 7 |
+| **OS**  | Windows 7 & Linux |
 | **GPU** | Graphics card supporting OpenGL 4.5 |
-| **CPU** | x64 |
+| **CPU** | x86_64 |
 
 # Screenshots
 ![editor](https://github.com/user-attachments/assets/b1ab6300-774a-4733-a810-4cece269aef2)

Scripts/Linux/BuildAll.sh

@@ -14,7 +14,7 @@ popd > /dev/null
 # Build the solution
 echo "Building Overload in $CONFIGURATION mode..."
 
-pushd "$(dirname "$0")/../../Sources/Overload" > /dev/null
+pushd "$(dirname "$0")/../.." > /dev/null
 make config=${CONFIG_LOWER}_x64 -j$(nproc)
 BUILD_RESULT=$?
 popd > /dev/null

Scripts/Linux/GenerateProjects.sh

@@ -6,6 +6,6 @@ ACTION="${1:-gmake}"
 SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
 PREMAKE_PATH="$SCRIPT_DIR/../../Dependencies/premake5/bin/premake5"
 
-pushd "$SCRIPT_DIR/../../Sources/Overload" > /dev/null
+pushd "$SCRIPT_DIR/../.." > /dev/null
 "$PREMAKE_PATH" "$ACTION"
 popd > /dev/null

Scripts/Windows/BuildAll.bat

@@ -59,7 +59,10 @@ echo msbuild.exe found at: "!MSBUILD_PATH!"
 echo.
 
 :: Build the solution
-pushd "%~dp0..\..\Sources\Overload\"
+echo Building Overload in !CONFIGURATION! mode...
+echo.
+
+pushd "%~dp0..\..\"
 if "%CONFIGURATION%"=="" (
     echo Building with default configuration configuration...
     "!MSBUILD_PATH!" Overload.sln -m -verbosity:minimal

Scripts/Windows/GenerateProjects.bat

@@ -2,8 +2,8 @@
 SET version=%~1%
 if "%~1"=="" SET version="vs2022"
 
-SET premake_path="%~dp0\..\Dependencies\premake5\bin\premake5.exe"
+SET premake_path="%~dp0\..\..\Dependencies\premake5\bin\premake5.exe"
 
-pushd "%~dp0\..\Sources\Overload"
+pushd "%~dp0\..\.."
 call %premake_path% %version%
 popd

Sources/Overload/OvAudio/premake5.lua → Sources/OvAudio/premake5.lua

@@ -18,9 +18,9 @@ project "OvAudio"
 		dependdir .. "soloud/include",
 
 		-- Overload SDK
-		"%{wks.location}/OvDebug/include",
-		"%{wks.location}/OvMaths/include",
-		"%{wks.location}/OvTools/include",
+		"%{wks.location}/Sources/OvDebug/include",
+		"%{wks.location}/Sources/OvMaths/include",
+		"%{wks.location}/Sources/OvTools/include",
 
 		-- Current Project
 		"include"

Sources/Overload/OvCore/premake5.lua → Sources/OvCore/premake5.lua

@@ -28,14 +28,14 @@ project "OvCore"
 		dependdir .. "tracy",
 
 		-- Overload SDK
-		"%{wks.location}/OvAudio/include",
-		"%{wks.location}/OvDebug/include",
-		"%{wks.location}/OvMaths/include",
-		"%{wks.location}/OvPhysics/include",
-		"%{wks.location}/OvRendering/include",
-		"%{wks.location}/OvTools/include",
-		"%{wks.location}/OvUI/include",
-		"%{wks.location}/OvWindowing/include",
+		"%{wks.location}/Sources/OvAudio/include",
+		"%{wks.location}/Sources/OvDebug/include",
+		"%{wks.location}/Sources/OvMaths/include",
+		"%{wks.location}/Sources/OvPhysics/include",
+		"%{wks.location}/Sources/OvRendering/include",
+		"%{wks.location}/Sources/OvTools/include",
+		"%{wks.location}/Sources/OvUI/include",
+		"%{wks.location}/Sources/OvWindowing/include",
 
 		-- Current project
 		"include",

Sources/Overload/OvDebug/premake5.lua → Sources/OvDebug/premake5.lua

@@ -15,7 +15,7 @@ project "OvDebug"
 
 	includedirs {
 		-- Overload SDK
-		"%{wks.location}/OvTools/include",
+		"%{wks.location}/Sources/OvTools/include",
 
 		-- Current Project
 		"include"

Sources/Overload/OvEditor/premake5.lua → Sources/OvEditor/premake5.lua

@@ -3,7 +3,7 @@ project "OvEditor"
 	cppdialect "C++20"
 	targetdir (outputdir .. "%{cfg.buildcfg}/%{prj.name}")
 	objdir (objoutdir .. "%{cfg.buildcfg}/%{prj.name}")
-	debugdir "%{wks.location}/../../Build/%{cfg.buildcfg}"
+	debugdir "%{wks.location}/Build/%{cfg.buildcfg}"
 
 	files {
 		"**.h",
@@ -21,15 +21,15 @@ project "OvEditor"
 		dependdir .. "tracy",
 
 		-- Overload SDK
-		"%{wks.location}/OvAudio/include",
-		"%{wks.location}/OvCore/include",
-		"%{wks.location}/OvDebug/include",
-		"%{wks.location}/OvMaths/include",
-		"%{wks.location}/OvPhysics/include",
-		"%{wks.location}/OvRendering/include",
-		"%{wks.location}/OvTools/include",
-		"%{wks.location}/OvUI/include",
-		"%{wks.location}/OvWindowing/include",
+		"%{wks.location}/Sources/OvAudio/include",
+		"%{wks.location}/Sources/OvCore/include",
+		"%{wks.location}/Sources/OvDebug/include",
+		"%{wks.location}/Sources/OvMaths/include",
+		"%{wks.location}/Sources/OvPhysics/include",
+		"%{wks.location}/Sources/OvRendering/include",
+		"%{wks.location}/Sources/OvTools/include",
+		"%{wks.location}/Sources/OvUI/include",
+		"%{wks.location}/Sources/OvWindowing/include",
 
 		-- Current project
 		"include"
@@ -95,7 +95,7 @@ project "OvEditor"
 			"xcopy \"%{resdir}Editor\\*\" \"%{builddir}%{cfg.buildcfg}\\Data\\Editor\" /y /i /r /e /q",
 			"xcopy \"%{prj.location}\\Layout.ini\" \"%{builddir}%{cfg.buildcfg}\\Config\\\" /y /i",
 
-			"xcopy \"%{wks.location}\\..\\..\\Tools\\tracy-profiler.exe\" \"%{builddir}%{cfg.buildcfg}\\Tools\\\" /y /i",
+			"xcopy \"%{wks.location}\\Tools\\tracy-profiler.exe\" \"%{builddir}%{cfg.buildcfg}\\Tools\\\" /y /i",
 
 			"xcopy /Y /I /Q /D \"%{outputdir}%{cfg.buildcfg}\\%{prj.name}\\*.exe\" \"%{builddir}%{cfg.buildcfg}\\\"",
 			"xcopy /Y /I /Q /D \"%{outputdir}%{cfg.buildcfg}\\%{prj.name}\\*.dll\" \"%{builddir}%{cfg.buildcfg}\\\"",

Sources/Overload/OvGame/premake5.lua → Sources/OvGame/premake5.lua

@@ -20,15 +20,15 @@ project "OvGame"
 		dependdir .. "tracy",
 
 		-- Overload SDK
-		"%{wks.location}/OvAudio/include",
-		"%{wks.location}/OvCore/include",
-		"%{wks.location}/OvDebug/include",
-		"%{wks.location}/OvMaths/include",
-		"%{wks.location}/OvPhysics/include",
-		"%{wks.location}/OvRendering/include",
-		"%{wks.location}/OvTools/include",
-		"%{wks.location}/OvUI/include",
-		"%{wks.location}/OvWindowing/include",
+		"%{wks.location}/Sources/OvAudio/include",
+		"%{wks.location}/Sources/OvCore/include",
+		"%{wks.location}/Sources/OvDebug/include",
+		"%{wks.location}/Sources/OvMaths/include",
+		"%{wks.location}/Sources/OvPhysics/include",
+		"%{wks.location}/Sources/OvRendering/include",
+		"%{wks.location}/Sources/OvTools/include",
+		"%{wks.location}/Sources/OvUI/include",
+		"%{wks.location}/Sources/OvWindowing/include",
 
 		-- Current project
 		"include"

Sources/Overload/OvPhysics/premake5.lua → Sources/OvPhysics/premake5.lua

@@ -19,9 +19,9 @@ project "OvPhysics"
 		dependdir .. "bullet3/bullet",
 
 		-- Overload SDK
-		"%{wks.location}/OvDebug/include",
-		"%{wks.location}/OvMaths/include",
-		"%{wks.location}/OvTools/include",
+		"%{wks.location}/Sources/OvDebug/include",
+		"%{wks.location}/Sources/OvMaths/include",
+		"%{wks.location}/Sources/OvTools/include",
 
 		-- Current Project
 		"include"