Skip to content

Commit 93e3f2c

Browse files
authored
docs: Add experimental instructions for macOS
1 parent c4b53d8 commit 93e3f2c

File tree

2 files changed

+103
-1
lines changed

2 files changed

+103
-1
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,23 @@ $ ninja install
8282
$ meson test
8383
```
8484

85+
## MacOS support (experimental)
86+
Most of the dependencies can be installed via [brew](https://brew.sh)
87+
```bash
88+
cd Gameeky
89+
brew install meson pkg-config libadwaita cmake gtksourceview5 desktop-file-utils gstreamer adwaita-icon-theme
90+
meson setup _build --prefix=~/.local -Dwebkit=disabled
91+
cd _build
92+
ninja install
93+
cd ..
94+
GSK_RENDERER=gl ~/.local/bin/dev.tchx84.Gameeky.Launcher
95+
```
96+
For more detailed instructions check [this guide](./docs/experimental/macOS/README.md)
97+
98+
8599
## Windows support (experimental)
86100

87-
To run on windows, install [msys2](msys2.org) and follow the instructions to set up a development environment. Once the setup is done, install the following dependencies:
101+
To run on windows, install [msys2](https://msys2.org) and follow the instructions to set up a development environment. Once the setup is done, install the following dependencies:
88102

89103
```bash
90104
$ pacman -Suy

docs/experimental/macOS/README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Building and Running Gameeky Launcher
2+
3+
This guide explains how to build and run **Gameeky Launcher** from source using **Meson** and **Ninja**.
4+
5+
---
6+
7+
## 1. Install Dependencies
8+
9+
**macOS (Homebrew):**
10+
11+
```bash
12+
brew install meson pkg-config libadwaita cmake gtksourceview5 desktop-file-utils gstreamer adwaita-icon-theme
13+
````
14+
15+
---
16+
17+
## 2. Configure and Build
18+
19+
Create the build directory and configure Meson:
20+
21+
```bash
22+
meson setup _build --prefix=~/.local -Dwebkit=disabled
23+
```
24+
25+
Then build and install:
26+
27+
```bash
28+
cd _build
29+
ninja install
30+
```
31+
32+
---
33+
34+
## 3. Run Tests (Optional)
35+
36+
```bash
37+
meson test
38+
```
39+
40+
---
41+
42+
## 4. Launch Gameeky
43+
44+
Run the launcher:
45+
46+
```bash
47+
cd ..
48+
GSK_RENDERER=gl ~/.local/bin/dev.tchx84.Gameeky.Launcher
49+
```
50+
51+
If you don't have it already you can add `~/.local/bin` to your `PATH`:
52+
53+
```bash
54+
export PATH=$PATH:~/.local/bin
55+
```
56+
And then run:
57+
58+
```bash
59+
GSK_RENDERER=gl dev.tchx84.Gameeky.Launcher
60+
```
61+
62+
> 💡 `GSK_RENDERER=gl` forces GTK to use OpenGL for rendering, instead of Vulkan.
63+
64+
Another option:
65+
```bash
66+
export GSK_RENDERER=gl
67+
./dist/bin/dev.tchx84.Gameeky.Launcher
68+
```
69+
70+
---
71+
72+
## 5. Install Theme Pack
73+
74+
(Optional) Install the **Freedom Valley** theme pack:
75+
76+
```bash
77+
mkdir -p ~/Gameeky
78+
cd ~/Gameeky
79+
git clone https://github.com/tchx84/FreedomValley.git
80+
```
81+
82+
---
83+
84+
## 6. Done!
85+
86+
You should now have **Gameeky Launcher** running locally with your chosen theme.
87+
88+

0 commit comments

Comments
 (0)