Added CMAKE support, tested on MacOS 14 and Windows 10 #6

Longwater1234 · 2024-04-02T15:42:32Z

cmake support with building instructions and requirements
tested on macOS 14 Sonoma and Windows 10
On macOS , it buils an app Bundle, with assets embedded inside.
attaches icon to .EXE on windows, and .app on MacOS
Added clang-format according to your code style (Google style)
Cross-platform resource loader class, to help get assets from disk or bundle.

mircea-pavel-anton · 2024-04-03T15:19:02Z

Hello @Longwater1234 and thanks for your PR!

It's been a while since I had a look at this project, but I'll do my best and review this PR as soon as I possibly can, hopefully this weekend!
I assume since this isn't a draft PR that it is done and ready for review?

Longwater1234 · 2024-04-03T15:22:47Z

Yes its done. You may review it.

…

On Wed, Apr 3, 2024, 23:19 Mircea-Pavel Anton ***@***.***> wrote: Hello @Longwater1234 <https://github.com/Longwater1234> and thanks for your PR! It's been a while since I had a look at this project, but I'll do my best and review this PR as soon as I possibly can, hopefully this weekend! I assume since this isn't a draft PR that it is done and ready for review? — Reply to this email directly, view it on GitHub <#6 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AIDJPXCVE35WM2XZRVQAEKDY3QMXZAVCNFSM6AAAAABFTURHESVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMZUHEYDKMZYGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Longwater1234 · 2024-04-04T07:54:03Z

@mirceanton One more thing! You may also need to change the github workflows to use Cmake for Multiplatform builds. Cheers😁. Suggestions: Build for 3 platforms: Windows-latest, MacOS latest, Ubuntu latest

Longwater1234 · 2024-04-16T12:16:17Z

@mirceanton Hello, just reminding about the review, if it's ok

mircea-pavel-anton · 2024-04-18T17:53:06Z

@mirceanton Hello, just reminding about the review, if it's ok

Hi! I haven't forgotten, I've just been very busy with work. I'll look on this ASAP. In the meantime feel free to take a crack at the pipelines, if that's something you're interested in.

mircea-pavel-anton

I managed to get CMake working in a Windows 11 environment using VisualStudio 2022 and SFML-2.6.1

After fixing the path for the windows icon, I managed to start the project but I'm having some trouble actually running it.

I'll need to look into this some more eventually :)) it's been 3y since I touched C++

Also, I don't think I can really accept and merge these changes without updating the workflows as well, and I am 99% sure I won't really have the time to spend doing that as work has been keeping me rather busy.

Other notes:

The comments I added thus far are only in regards to the documentation since that is the only part I managed to focus on to get things going.
The code style changes/fixes seem fine.
I have no means to test the Mac compatibility which would normally make me want to leave it out since I will not be able to provide any support on this going forward.
I would have preferred to keep the .vscode tasks configuration since that was really cross platform assuming you have all of the required tools, but I can't say I am 100% sold on this
You should probably ignore all the .DS_Store files via .gitignore since, at least AFAIK, they are not needed

mircea-pavel-anton · 2024-04-23T19:32:02Z

BUILDING.md

+   sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
+  ```
+- This is how the home screen of CMake GUI looks like:
+![cmake_screenshot](apple_cmake/cmake_gui.png)


This hyperlink seems to be broken as that file is not included in this repo/PR Maybe you meant cmake/cmake_gui.png?

mircea-pavel-anton · 2024-04-23T19:34:36Z

BUILDING.md

+## On Windows
+1. Just open this project folder in Visual Studio 2019 (or newer), with 


Markdown syntax requires a newline after titles

mircea-pavel-anton · 2024-04-23T19:34:43Z

BUILDING.md

+## On MacOS & Linux
+1. Open this project directory in your terminal.


Markdown syntax requires a newline after titles

BUILDING.md

mircea-pavel-anton · 2024-04-23T19:36:06Z

README.md

+### For Linux
+- Use your OS package manager to download SFML 2.5 or newer.


Markdown syntax requires a newline after titles

README.md

mircea-pavel-anton · 2024-04-23T19:37:04Z

cmake/README.md

+### Extra notes
+If you installed SFML as "Frameworks", instead of "dylibs", you will need to embed the SFML frameworks (using Xcode) into the App Bundle, if you want to share your app with others. Use CMake GUI to generate an **XCode** project. Open project in XCode. Click menu **Editor** > **Add Build Phase** > **Add Copy Files Build Phase**. Click the `[+]` button at top, and select all SFML frameworks from `/Library/Frameworks` (audio, video, system etc.). Now you can **Build** your project. 


Markdown syntax requires a newline after titles

mircea-pavel-anton · 2024-04-23T19:44:28Z

res/win-icon.rc

@@ -0,0 +1 @@
+IDI_ICON1 ICON DISCARDABLE "windows-icon.ico"


I think this should be "windows_icon.ico". My VS project would fail at compiling otherwise

Longwater1234 · 2024-04-25T05:06:14Z

@mirceanton Oh, it's sad to see you cannot run it on Win11. I will cross check again on a fresh Windows installation.

Concerning workflows, i will add for all 3 main platforms (Win, MacOS, Linux), and run the workflow on my GitHub, so you can see the results.
For the .vscode i will restore the folder 📂
Sorry about .DS_Store files, i used wildcard to ignore it, but turns out it was already committed to Git. Could not catch them all on my Mac (they are hidden). I will fix this.
I will resolve all the issues you listed in the comments this weekend.

mircea-pavel-anton · 2024-04-25T05:36:44Z

@mirceanton Oh, it's sad to see you cannot run it on Win11. I will cross check again on a fresh Windows installation.

Concerning workflows, i will add for all 3 main platforms (Win, MacOS, Linux), and run the workflow on my GitHub, so you can see the results.

For the .vscode i will restore the folder 📂

Sorry about .DS_Store files, i used wildcard to ignore it, but turns out it was already committed to Git. Could not catch them all on my Mac (they are hidden). I will fix this.

I will resolve all the issues you listed in the comments this weekend.

That's great! Thank you for your contributions!

Longwater1234 · 2024-05-04T09:39:46Z

@mirceanton i have fixed all the issues in the comments. The game can now run properly on Windows. Except for restoring .vscode 📁 folder, because i have observed files within vscode folder were specifically for Makefile, while now we have migrated to Cmake build. No worries, the make can still be used with CMake just smoothly, see BUILDING.md 😊

Create cmake-multi-platform.yml

Newer Update cmake-multi-platform.yml

Longwater1234 · 2024-05-04T10:50:18Z

@mirceanton Done added workflows for Windows and Ubuntu using Cmake. Both finish successfully. You can view on my github fork, on Actions tab.

.github/workflows/cmake-multi-platform.yml

README.md

mircea-pavel-anton · 2024-06-15T14:28:02Z

@Longwater1234 looks good. I went ahead and got this merged. Thanks for the contribution!

Longwater1234 added 14 commits April 1, 2024 12:57

added clang-format based on Google

433d82c

created CmakeLists.txt for all desktop OS

a3174db

format source code with clang-format

a9b6c6c

add ResourcePath helper for loading assets

8e2a37e

simplify config.hpp load resources

c521ee2

format using clang-format

e523220

can copy all folders recursively

dd77f04

ignore DS_store

529f385

more code cleanup

89c1ee9

load map using ResourceLoader

f013e6c

added requirments for building

4329b9a

added building instructions

e0c2522

tip for windows exe failing

13eff78

Added screenshot for Cmake GUI

03e286a

mircea-pavel-anton added the enhancement New feature or request label Apr 3, 2024

mircea-pavel-anton self-assigned this Apr 3, 2024

Longwater1234 and others added 7 commits April 4, 2024 16:45

add more notes in apple README

cc97615

set minimum cmake to 3.20

ef38e93

FIX bug copy resources using cmake for MacOS

496a00e

simplify macos copy resources into bundle

929453a

rename apple_cmake to cmake folder

d1adeb9

delete and gitignore vscode folder

fdfaaf6

minor comment fix

d928a5c

mircea-pavel-anton reviewed Apr 23, 2024

View reviewed changes

Longwater1234 added 5 commits May 4, 2024 16:57

remove all DS_Store files

8f96638

fix icon path

ac3701d

FIX path problem in getResourcePath.cpp

967eff7

fix Markdown links and spacing

768ff5d

remove old worflow directory

513f6ad

Longwater1234 and others added 8 commits May 4, 2024 17:45

added CmakeSettings.json for Visual Studio

d21b21a

specify in README.md can install SFML 2.5 or higher

dabab1d

Create cmake-multi-platform.yml

7c4ea77

Merge pull request #1 from Longwater1234/Longwater1234-patch-1

605a5be

Create cmake-multi-platform.yml

Update cmake-multi-platform.yml

7334771

Update cmake-multi-platform.yml

2f9be89

remove .mm glob from main CmakeLists.txt

eb285f2

Merge pull request #4 from Longwater1234/Longwater1234-patch-2

83995ee

Newer Update cmake-multi-platform.yml

mircea-pavel-anton suggested changes May 14, 2024

View reviewed changes

.github/workflows/cmake-multi-platform.yml Outdated Show resolved Hide resolved

.github/workflows/cmake-multi-platform.yml Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

Longwater1234 added 5 commits June 8, 2024 17:14

download SFML on linux using CURL from official site

9f181de

set BUILD_DIR as env

5576f99

fix sfml_dir path in matrix

68c602e

use sudo to download and unarchive sfml on ubuntu

e2a913e

revert back to using apt-get install SFML on ubuntu

04af518

mircea-pavel-anton merged commit 230ea09 into mircea-pavel-anton:master Jun 15, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added CMAKE support, tested on MacOS 14 and Windows 10 #6

Added CMAKE support, tested on MacOS 14 and Windows 10 #6

Longwater1234 commented Apr 2, 2024

mircea-pavel-anton commented Apr 3, 2024

Longwater1234 commented Apr 3, 2024 via email

Longwater1234 commented Apr 4, 2024 •

edited

Loading

Longwater1234 commented Apr 16, 2024

mircea-pavel-anton commented Apr 18, 2024

mircea-pavel-anton left a comment

mircea-pavel-anton Apr 23, 2024

mircea-pavel-anton Apr 23, 2024

mircea-pavel-anton Apr 23, 2024

mircea-pavel-anton Apr 23, 2024

mircea-pavel-anton Apr 23, 2024

mircea-pavel-anton Apr 23, 2024

Longwater1234 commented Apr 25, 2024 •

edited

Loading

mircea-pavel-anton commented Apr 25, 2024

Longwater1234 commented May 4, 2024 •

edited

Loading

Longwater1234 commented May 4, 2024

mircea-pavel-anton commented Jun 15, 2024

		## On Windows
		1. Just open this project folder in Visual Studio 2019 (or newer), with

		## On MacOS & Linux
		1. Open this project directory in your terminal.

		### For Linux
		- Use your OS package manager to download SFML 2.5 or newer.

		### Extra notes
		If you installed SFML as "Frameworks", instead of "dylibs", you will need to embed the SFML frameworks (using Xcode) into the App Bundle, if you want to share your app with others. Use CMake GUI to generate an XCode project. Open project in XCode. Click menu Editor > Add Build Phase > Add Copy Files Build Phase. Click the `[+]` button at top, and select all SFML frameworks from `/Library/Frameworks` (audio, video, system etc.). Now you can Build your project.

Added CMAKE support, tested on MacOS 14 and Windows 10 #6

Added CMAKE support, tested on MacOS 14 and Windows 10 #6

Conversation

Longwater1234 commented Apr 2, 2024

mircea-pavel-anton commented Apr 3, 2024

Longwater1234 commented Apr 3, 2024 via email

Longwater1234 commented Apr 4, 2024 • edited Loading

Longwater1234 commented Apr 16, 2024

mircea-pavel-anton commented Apr 18, 2024

mircea-pavel-anton left a comment

Choose a reason for hiding this comment

mircea-pavel-anton Apr 23, 2024

Choose a reason for hiding this comment

mircea-pavel-anton Apr 23, 2024

Choose a reason for hiding this comment

mircea-pavel-anton Apr 23, 2024

Choose a reason for hiding this comment

mircea-pavel-anton Apr 23, 2024

Choose a reason for hiding this comment

mircea-pavel-anton Apr 23, 2024

Choose a reason for hiding this comment

mircea-pavel-anton Apr 23, 2024

Choose a reason for hiding this comment

Longwater1234 commented Apr 25, 2024 • edited Loading

mircea-pavel-anton commented Apr 25, 2024

Longwater1234 commented May 4, 2024 • edited Loading

Longwater1234 commented May 4, 2024

mircea-pavel-anton commented Jun 15, 2024

Longwater1234 commented Apr 4, 2024 •

edited

Loading

Longwater1234 commented Apr 25, 2024 •

edited

Loading

Longwater1234 commented May 4, 2024 •

edited

Loading