{"id":17288528,"url":"https://github.com/moros1138/pge-template-project","last_synced_at":"2025-04-14T11:11:41.419Z","repository":{"id":49585117,"uuid":"513392441","full_name":"Moros1138/pge-template-project","owner":"Moros1138","description":"This is a template project using CMake to serve as a jumping off point for you to build your masterpiece olcPixelGameEngine application.","archived":false,"fork":false,"pushed_at":"2024-07-23T11:25:24.000Z","size":4753,"stargazers_count":27,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-14T11:11:36.791Z","etag":null,"topics":["arch-linux","clang","cmake","emscripten","gcc","linux","macos","manjaro-linux","ubuntu","visual-studio","windows"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Moros1138.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-13T05:31:17.000Z","updated_at":"2024-12-08T13:47:28.000Z","dependencies_parsed_at":"2024-06-18T03:29:55.575Z","dependency_job_id":"bc0a9dee-0d58-4865-adf8-f99a52a2d946","html_url":"https://github.com/Moros1138/pge-template-project","commit_stats":null,"previous_names":[],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moros1138%2Fpge-template-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moros1138%2Fpge-template-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moros1138%2Fpge-template-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Moros1138%2Fpge-template-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Moros1138","download_url":"https://codeload.github.com/Moros1138/pge-template-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248868766,"owners_count":21174758,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arch-linux","clang","cmake","emscripten","gcc","linux","macos","manjaro-linux","ubuntu","visual-studio","windows"],"created_at":"2024-10-15T10:28:35.867Z","updated_at":"2025-04-14T11:11:41.395Z","avatar_url":"https://github.com/Moros1138.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PGE Template Project v2.25\n\nThis is a template project for use with the [olcPixelGameEngine](https://github.com/OneLoneCoder/olcPixelGameEngine). It serves as a jumping off point for you to build your masterpiece application.\n\n## Features\n\nCMake script for cross-platform building. Tested environments include:\n\n* Linux - with UNIX Makefiles, GNU GCC and LLVM Clang\n* MacOS - with UNIX Makefiles, XCode and LLVM Clang\n* Windows - with Visual Studio, NMake Makefiles, and MinGW Makefiles\n* Emscripten - with UNIX Makefiles, NMake Makefiles, and MinGW Makefiles\n\n# Preparing your Environment\n\nThe instructions to prepare your environment have been broken up for convenience. Simply follow the instructions that are pertinent to your situation.\n\n## Linux\n\n### **Requirements**\n\n* C/C++ Toolchain for your Linux distro\n* CMake\n* Git\n* libpng\n* Mesa OpenGL Development Libraries\n\n### **Ubuntu and Ubuntu based distros**\n\nUpdate your package manager by issuing the following command:\n\n```\nsudo apt update\n```\n\nInstall toolchain and required software by issuing the following command:\n\n```\nsudo apt install build-essential cmake git libpng-dev libglu1-mesa-dev\n```\n\n### **Arch, Manjaro, and Arch based distros**\n\n```\nsudo pacman -Sy base-devel cmake git libpng mesa\n```\n\n## MacOS\n\n### **Requirements**\n\n* XCode\n* [Homebrew Package Manager](https://brew.sh/)\n* libpng\n* CMake\n* git\n\nInstall XCode from the App Store.\n\nOpen the ``Terminal`` App from Finder. go to Applications -\u003e Utilities\n\nFollow the instructions at the [Homebrew Website](https://brew.sh/) to install the Homebrew package manager.\n\nOnce Homebrew is installed, issue the following command to install ``cmake``,``libpng``, and ``git``:\n\n\n```\nbrew install libpng \nbrew install cmake\nbrew install git\n```\n\n## Windows\n\n### Requirements\n\n* Chocolatey\n* CMake\n* Toolchain (MinGW or Visual Studio / NMake)\n\nThe following will be required whether you use MinGW or Visual Studio.You will need to open Powershell, as Administrator.\n\nVisit the [Chocolatey website](https://chocolatey.org/) for instructions on how to install Chocolatey.\n\nOnce you've got Chocolatey installed, we can install CMake:\n\n```\nchoco install cmake\n```\n\nSay ``yes`` to all of the scripts Chocolatey wants you to run!\n\nAfter the installation has completed, find the Cmake ``bin`` directory, it is typically ``C:\\Program Files\\CMake\\bin`` and add it to your path!\n\nConfirm CMake is installed and in your path by issuing the following command in a Command Prompt:\n\n```\ncmake --version\n```\n\nIf you recieve an ``command not found`` error double check that you have actually added CMake to your path.\n\n## MinGW\n\nInstall MinGW via ``choco install mingw`` from Powershell as Administrator\n\n\n## Visual Studio / NMake\n\nDownload and install [Visual Studio: Community Edition](https://visualstudio.microsoft.com/downloads/).\n\nEnsure that you have installed the Desktop C++ option!\n\n# **Usage**\n\nIF YOU HAVE MADE IT HERE AND YOU HAVE NOT SET UP YOUR DEVELOPMENT ENVIRONMENT, GO BACK UP AND READ THE INSTRUCTIONS AGAIN!\n\n## Linux / MacOS (with default toolchains)\n\nOpen a Terminal and navigate to the directory which you downloaded the project. Issue the following command:\n\n```\ncmake . -B linux-build -G \"Unix Makefiles\"\n```\n\nCMake will generate UNIX Makefiles you can use to build the project, like so:\n\n```\ncmake --build linux-build\n```\n\nThe compiled binary will be located in ``linux-build/bin`` directory.\n\n**NOTE: if you're executing the program, ensure you have the correct working directory, which contains the executable!**\n\n## MacOS (with XCode)\n\nOpen a Terminal and navigate to the directory which you downloaded the project. Issue the following command:\n\n```\ncmake . -B xcode-build -G \"xcode\"\n```\n\nCMake will generate an XCode project in ``xcode-build``. You can use it like any other XCode project.\n\n## Linux / MacOS (Emscripten)\n\n**These instructions assume you have Emscripten installed, activated, and have the environment set up for an active Terminal.**\n\nOpen a Terminal and navigate to the directory which you downloaded the project. Issue the following command:\n\n```\nemcmake cmake . -B emscripten-build\n```\n\nEmscripten's ``emcmake`` utility will invoke CMake with all the magic required to make it work with Emscripten. Generating UNIX Makefiles you can use to build the project, like so:\n\n```\ncmake --build emscripten-build\n```\n\nThe compiled HTML, Javascript, WebAssembly, and Data will be in the ``emscripten-build/bin`` directory.\n\nIf you lack some sort of live server extension to your IDE, you can view it using the ``emrun`` utility, like so:\n\n```\nemrun path/to/build/bin/PROJECTNAME.html\n```\n\nThis command should launch the project in your default web browser.\n\n## Windows (MinGW)\n\nOpen the ``Command Prompt`` prompt and navigate to the directory which you downloaded the project. Issue the following command:\n\n```\ncmake . -B mingw-build -G \"MinGW Makefiles\"\n```\n\nCMake will generate MinGW Makefiles you can use to build the project, like so:\n\n```\ncmake --build mingw-build\n```\n\nThe compiled binary will be located in the ``mingw-build/bin`` directory.\n\n**NOTE: if you're executing the program, ensure you have the correct working directory, which contains the executable!**\n\n## Windows (NMake)\n\nOpen the ``x64 Native Tools Command Prompt for VS 2022`` prompt and navigate to the directory which you downloaded the project. Issue the following command:\n\n```\ncmake . -B nmake-build -G \"NMake Makefiles\"\n```\n\nCMake will generate NMake Makefiles you can use to build the project, like so:\n\n```\ncmake --build nmake-build \n```\n\nThe compiled binary will be located in ``nmake-build/bin`` directory.\n\n**NOTE: if you're executing the program, ensure you have the correct working directory, which contains the executable!**\n\n## Windows (Visual Studio)\n\nOpen the ``Command Prompt`` prompt and navigate to the directory which you downloaded the project. Issue the following command:\n\n```\ncmake . -B vs-build\n```\n\nCMake will generate a Visual Studio solution and project in ``vs-build``. You can use it like any other Visual Studio Project.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoros1138%2Fpge-template-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoros1138%2Fpge-template-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoros1138%2Fpge-template-project/lists"}