Merge branch 'Template' into github-actions

Author: JohnnyCena123

.github/workflows/Build.yml

@@ -176,29 +176,27 @@ jobs:
       - name: Build
         id: build
         run: |
+          sudo apt-get update && sudo apt-get install -y libopengl0 libglu1-mesa
           PACKAGE_NAME=${{ github.ref_name }}
-          PACKAGE_VERSION=1.0.0
+          chmod +x ./$PACKAGE_NAME
+          PACKAGE_VERSION=$(./$PACKAGE_NAME --version --minimal-output)
+          PACKAGE_DESC="$(./$PACKAGE_NAME --desc --minimal-output)"
           PACKAGE_DIR="./$PACKAGE_NAME-$PACKAGE_VERSION"
           mkdir -p "$PACKAGE_DIR"/usr/bin
-          chmod +x ./$PACKAGE_NAME
           mv "./$PACKAGE_NAME" "$PACKAGE_DIR/usr/bin/"
           ln -sf libraylib.so.5.5.0 libraylib.so.550
           ln -sf libraylib.so.5.5.0 libraylib.so
           mkdir -p "$PACKAGE_DIR"/usr/lib/$PACKAGE_NAME
           mv ./*.so* "$PACKAGE_DIR/usr/lib/$PACKAGE_NAME/"
 
-          if [ -d "./resources" ]; then
-            mkdir -p "$PACKAGE_DIR/usr/share/$PACKAGE_NAME/"
-            cp -r ./resources "$PACKAGE_DIR/usr/share/$PACKAGE_NAME/"
-            if [ -f "./resources/icon.png" ]; then
-              ICON_DIR="usr/share/icons"
-              mkdir -p "$PACKAGE_DIR/$ICON_DIR"
-              ICON_PATH="$ICON_DIR/$PACKAGE_NAME.png"
-              cp ./resources/icon.png "$PACKAGE_DIR/$ICON_PATH"
-              DESKTOP_ICON_LINE="Icon=/$ICON_PATH"
-            fi
-            rm -rf resources
-          fi
+          mkdir -p "$PACKAGE_DIR/usr/share/$PACKAGE_NAME/"
+          cp -r ./resources "$PACKAGE_DIR/usr/share/$PACKAGE_NAME/"
+          ICON_DIR="usr/share/icons"
+          mkdir -p "$PACKAGE_DIR/$ICON_DIR"
+          ICON_PATH="$ICON_DIR/$PACKAGE_NAME.png"
+          cp ./resources/icon.png "$PACKAGE_DIR/$ICON_PATH"
+          DESKTOP_ICON_LINE="Icon=/$ICON_PATH"
+          rm -rf resources
 
           mkdir -p "$PACKAGE_DIR/usr/share/applications/"
           cat <<EOF > "$PACKAGE_DIR/usr/share/applications/$PACKAGE_NAME.desktop"
@@ -207,7 +205,7 @@ jobs:
           Name=$PACKAGE_NAME
           GenericName=$PACKAGE_NAME
           $DESKTOP_ICON_LINE
-          Comment=Placeholder - to be replaced
+          Comment=$PACKAGE_DESCRIPTION
           Exec=/usr/bin/$PACKAGE_NAME
           TryExec=/usr/bin/$PACKAGE_NAME
           Terminal=false
@@ -225,7 +223,8 @@ jobs:
           Priority: optional
           Architecture: amd64
           Maintainer: Johnny Cena <iamahuman1395@gmail.com>
-          Description: Placeholder - to be replaced
+          Description: $PACKAGE_DESCRIPTION
+          
           EOF
 
           dpkg-deb --build "$PACKAGE_DIR" "$PACKAGE_DIR".deb
@@ -234,7 +233,6 @@ jobs:
 
       - name: Test package
         run: |
-          sudo apt-get update && sudo apt-get install -y libopengl0 libglu1-mesa
           sudo dpkg -i ${{ steps.build.outputs.package-path }}
 
       - name: Upload
@@ -258,13 +256,8 @@ jobs:
         id: organize
         run: |
           rm -rf "Debian package" "Windows installer"
-          if [ -d "build-win-msvc/resources" ]; then 
-            echo "resources-found=true" >> $GITHUB_OUTPUT
-            mv build-win-msvc/resources .
-            rm -rf */resources
-          else
-            echo "resources-found=false" >> $GITHUB_OUTPUT
-          fi
+          mv build-win-msvc/resources .
+          rm -rf */resources
 
           mkdir Release
           mkdir RelWithDebInfo
@@ -298,7 +291,6 @@ jobs:
           name: RelWithDebInfo Builds
 
       - name: Upload resources zip
-        if: steps.organize.outputs.resources-found == 'true'
         uses: actions/upload-artifact@v4
         with:
           path: resources/*

CMakeLists.txt

@@ -7,7 +7,10 @@ execute_process(
 	OUTPUT_VARIABLE GIT_BRANCH
 	OUTPUT_STRIP_TRAILING_WHITESPACE
 )
-project(${GIT_BRANCH}) # i might decide to change this in specific branches but overall itll be the default
+project(${GIT_BRANCH}
+	LANGUAGES CXX
+	VERSION 1.0.0
+)
 
 if(NOT DONT_USE_CACHING_COMPILER)
 	message(STATUS "Looking for ccache/sccache")
@@ -96,9 +99,11 @@ if(DEFINED BIN_SUFFIX)
 	set_target_properties(${PROJECT_NAME} PROPERTIES OUTPUT_NAME "${PROJECT_NAME}-${BIN_SUFFIX}")
 endif()
 set_target_properties(${PROJECT_NAME} PROPERTIES
-  BUILD_RPATH "$ORIGIN:$ORIGIN/../lib/${PROJECT_NAME}:/usr/lib/${PROJECT_NAME}"
+	BUILD_RPATH "$ORIGIN:$ORIGIN/../lib/${PROJECT_NAME}:/usr/lib/${PROJECT_NAME}"
 )
 target_compile_definitions(${PROJECT_NAME} PRIVATE CMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE})
+target_compile_definitions(${PROJECT_NAME} PRIVATE PROJECT_NAME="${PROJECT_NAME}")
+target_compile_definitions(${PROJECT_NAME} PRIVATE PROJECT_VERSION="${PROJECT_VERSION}")
 target_include_directories(${PROJECT_NAME} PRIVATE ${raylib_SOURCE_DIR}/src)
 target_link_libraries(${PROJECT_NAME} raylib)
 

icon.rc

@@ -0,0 +1 @@
+IDI_ICON1 ICON "resources/icon.ico"

resources/icon.ico

@@ -0,0 +1,157 @@
+#include <raylib.h>
+#include <sstream>
+#include <iostream>
+#include <optional>
+#include "game.hpp"
+
+int traceLogLevel = LOG_INFO;
+
+void Game::handleArgv(int argc, char* argv[]) {
+
+	if (argc > 1) {
+		bool hasError = false;
+		struct Option {
+			std::optional<char> singleChar;
+			std::string full;
+			bool& v;
+		};
+        static auto _this = this; // static for the tracelog callback to be able to access it
+		bool minimalOutput = false;
+		static bool silent = false; // here too
+		bool verbose = false;
+		bool saveLogs = false;
+		bool printVersion = false;
+		bool printHelp = false;
+		bool printDescription = false;
+		static std::vector<Option> const options{
+			{ 'm', "--minimal-output", minimalOutput },
+			{ 's', "--silent", silent },
+			{ 'V', "--verbose", verbose },
+			{ 'S', "--save-logs", saveLogs },
+			{ 'v', "--version", printVersion },
+			{ 'h', "--help", printHelp },
+			{ 'u', "--usage", printHelp },
+			{ 'd', "--desc", printDescription },
+		};
+		
+		std::optional<Path> altSaveDir;
+		for (size_t i = 1; i < argc; i++) {
+			std::string arg = argv[i];
+			if (arg.starts_with("--")) {
+				bool found = false;
+				static char constexpr ALT_SAVE_DIR_ARG[] = "--save-dir=";
+				if (arg.starts_with(ALT_SAVE_DIR_ARG)) {
+					altSaveDir = arg.substr(sizeof(ALT_SAVE_DIR_ARG) - 1, std::string::npos);
+					found = true;
+				} else for (auto const& option : options) {
+					if (arg == option.full) {
+						option.v = found = true;
+						break;
+					}
+				}
+				if (!found) {
+					std::cerr << argv[0] << ": \033[31merror\033[0m: unrecognized option -- " << arg << std::endl;
+					hasError = true;
+				}
+			} else if (arg.starts_with("-")) {
+				for (size_t i = 1; i < arg.size(); i++) {
+					bool found = false;
+					for (auto const& option : options)  {
+						if (arg[i] == option.singleChar) {
+							option.v = found = true;
+							break;
+						}
+					}
+					if (!found) {
+						std::cerr << argv[0] << ": \033[31merror\033[0m: unrecognized option -- -" << arg[i] << std::endl;
+						hasError = true;
+					}
+				}
+			} else {
+				std::cerr << argv[0] << ": \033[31merror\033[0m: invalid argument -- " << arg << std::endl;
+				hasError = true;
+			}
+		}
+        /* 
+		std::cout << "args found:\n";
+		for (auto const& option : options) {
+			if (option.v){
+				std::cout << '\t';
+				if (option.singleChar) std::cout << '-' << *option.singleChar << '/';
+				std::cout << option.full << '\n';
+			}
+		}
+ */
+        if (verbose) traceLogLevel = LOG_TRACE;
+        m_shouldSaveLogs = saveLogs;
+
+		auto traceLogCallback = [](int logType, const char* text, va_list args) {
+			static size_t constexpr MAX_TRACELOG_MSG_LENGTH = 512;
+			if (logType < traceLogLevel) return;
+
+			va_list argsCopy;
+			va_copy(argsCopy, args);
+			int size = std::vsnprintf(nullptr, 0, text, argsCopy);
+			va_end(argsCopy);
+			std::vector<char> buffer(size + 1);
+			std::vsnprintf(buffer.data(), buffer.size(), text, args);
+
+			std::time_t currentTime = std::time(0); 
+			std::tm* localTime = std::localtime(&currentTime);
+
+			std::stringstream ss;
+			ss << "[ "
+				<< localTime->tm_hour << ":"
+				<< localTime->tm_min << ":"
+				<< localTime->tm_sec << " ] ";
+			switch (logType) {
+				case LOG_TRACE: ss << "TRACE: "; break;
+				case LOG_DEBUG: ss << "DEBUG: "; break;
+				case LOG_INFO: ss << "INFO: "; break;
+				case LOG_WARNING: ss << "WARNING: "; break;
+				case LOG_ERROR: ss << "ERROR: "; break;
+				case LOG_FATAL: ss << "FATAL: "; break;
+				default: break;
+			}
+			ss << std::string(buffer.data());
+
+			if (!silent) std::cout << ss.str() << std::endl;
+			if (_this->m_shouldSaveLogs) _this->m_logs << ss.str() << std::endl;
+            _this->m_logs.flush();
+		};
+		SetTraceLogCallback(traceLogCallback);
+        
+		if (printVersion) {
+            if (minimalOutput) std::cout << PROJECT_VERSION "\n";
+            else std::cout << "'" PROJECT_NAME "' is a template - it is not a distributed product.\n"
+                "it does not follow the usual versioning scheme;\n"
+                "but its version could be considered as " PROJECT_VERSION " .\n";
+            exit(0);
+        } else if (printHelp) {
+            std::cout << "Usage: " << argv[0] << " <options>\n"
+                "    -m, --minimal-output   --  used for --version and --description. meant to automate package metadata in GitHub Actions.\n"
+                "    -s, --silent           --  disables all logging.\n"
+                "    -V,  --verbose         --  sets the log level to LOG_TRACE instead of LOG_INFO.\n"
+                "    -S,  --save-logs       --  saves logs to a file. unaffected by --silent.\n"
+                "    -h, --help             --  prints this help message and exits.\n"
+                "    -u, --usage            --  same as --help.\n"
+                "    -d, --desc,            --  prints a general description of this app.\n"
+                "        --save-dir=<dir>   --  sets a custom directory to use for save data. includes log files.\n";
+            exit(0);
+        } else if (printDescription) {
+            if (minimalOutput) std::cout << "Template project for raylib apps\n";
+            else std::cout << "'" PROJECT_NAME "' is a template project. it is used to easily create\n"
+                "and start new projects using raylib. it is not a full game nor an app.\n";
+            exit(0);
+        }
+
+        if (altSaveDir) {
+            if (!DirectoryExists((*altSaveDir).string().c_str())) 
+                MakeDirectory((*altSaveDir).string().c_str());
+            saveDir = *altSaveDir;
+        }
+
+		if (hasError) exit(1);
+	}
+
+}

resources/image.png

@@ -0,0 +1,31 @@
+#include <raylib.h>
+#include "basics.hpp"
+
+int screenWidth = 700;
+int screenHeight = 500;
+
+Path const resourceDir = [] -> Path {
+	Path const exeDir = GetApplicationDirectory();
+#ifdef _WIN32
+	return exeDir;
+#elif defined(__linux__)
+	if (exeDir.string().starts_with("/usr") && 
+		DirectoryExists("/usr/share/" PROJECT_NAME "/resources")
+	) return Path{"/usr/share"}/PROJECT_NAME/"resources";
+#endif
+	return exeDir/"resources";
+}();
+
+Path saveDir = [] -> Path {
+	Path ret = Path{GetApplicationDirectory()} / "save";
+#ifdef _WIN32
+	Path appData = std::getenv("APPDATA");
+	ret = appData/PROJECT_NAME;
+#elif defined(__linux__)
+	Path homeDir = std::getenv("HOME");
+	ret = homeDir/".local"/"share"/PROJECT_NAME;
+#endif
+	if (!DirectoryExists(ret.string().c_str())) 
+		MakeDirectory(ret.string().c_str());
+	return ret;
+}();

src/argv.cpp

@@ -0,0 +1,9 @@
+#pragma once
+#include <filesystem>
+
+int constexpr START_SCREEN_WIDTH = 700;
+int constexpr START_SCREEN_HEIGHT = 500;
+
+using Path = std::filesystem::path;
+extern Path const resourceDir;
+extern Path saveDir;

src/basics.cpp

@@ -0,0 +1,76 @@
+#include <cmath>
+#include <raylib.h>
+#include "game.hpp"
+#include "basics.hpp"
+
+Game::Game(int argc, char* argv[]) : m_shouldSaveLogs(false), m_logs(""),
+	m_screenWidth(START_SCREEN_WIDTH), m_screenHeight(START_SCREEN_HEIGHT), 
+	m_resourceManager() {
+	
+	handleArgv(argc, argv);
+
+	SetConfigFlags(FLAG_WINDOW_RESIZABLE);
+	InitWindow(m_screenWidth, m_screenHeight, "Hello!");
+	SetTargetFPS(60);
+
+    m_resourceManager.initialize();
+	if (!m_resourceManager.loadImage("app-icon", "icon.png"))
+		TraceLog(LOG_WARNING, "Failed to load app icon");
+	SetWindowIcon(m_resourceManager.getImage("app-icon"));
+
+	if (!m_resourceManager.loadTexture("image", "image.png"))
+		TraceLog(LOG_WARNING, "Failed to load dummy resource");
+	m_dummyResource = m_resourceManager.getTexture("image");
+}
+Game::~Game() {
+    m_resourceManager.uninitialize();
+	CloseWindow();
+
+	std::time_t currentTime = std::time(0); 
+	std::tm* localTime = std::localtime(&currentTime);
+
+	if (m_shouldSaveLogs) {
+		char const* logFileName = TextFormat("%i.%i.%i-%i:%i:%i.log",
+			localTime->tm_year + 1900,
+			localTime->tm_mon + 1,
+			localTime->tm_mday,
+			localTime->tm_hour,
+			localTime->tm_min,
+			localTime->tm_sec
+		);
+		Path logsDir = saveDir/"logs";
+		if (!DirectoryExists(logsDir.string().c_str())) MakeDirectory(logsDir.string().c_str());
+		SaveFileText((logsDir/logFileName).string().c_str(), m_logs.str().c_str());
+	}
+}
+
+void Game::run() {
+
+	while (!WindowShouldClose()) {
+		BeginDrawing();
+		ClearBackground(SKYBLUE);
+
+		m_dummyResourceRotation += GetFrameTime() * (70 * cos(GetTime() * 1.5) + 100.f);
+		if (m_dummyResourceRotation > 360) m_dummyResourceRotation -= 360;
+
+		float const scale = sin(GetTime()) + 2.f;
+		Vector2 const position = {
+			static_cast<float>(m_screenWidth - m_dummyResource.width * scale) / 2,
+			static_cast<float>(m_screenHeight - m_dummyResource.height * scale) / 2,
+		};
+
+		Vector2 texSize = { static_cast<float>(m_dummyResource.width), static_cast<float>(m_dummyResource.height) };
+
+		DrawTexturePro(m_dummyResource, { 0, 0, texSize.x, texSize.y }, { 
+			m_screenWidth / 2.f, m_screenHeight / 2.f, 
+			texSize.x * scale, texSize.y * scale 
+		}, { texSize.x / 2, texSize.y / 2 }, m_dummyResourceRotation, WHITE);
+
+		EndDrawing();
+
+		m_screenWidth = GetScreenWidth();
+		m_screenHeight = GetScreenHeight();
+	}
+
+
+}