1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52
53. 53
54. 54
55. 55
56. 56
57. 57
58. 58
59. 59
60. 60
61. 61
62. 62
63. 63
64. 64
65. 65
66. 66
67. 67
68. 68
69. 69
70. 70
71. 71
72. 72
73. 73
74. 74
75. 75
76. 76
77. 77
78. 78
79. 79
80. 80
81. 81
82. 82
83. 83
84. 84
85. 85
86. 86
87. 87
88. 88
89. 89
90. 90
91. 91
92. 92
93. 93
94. 94
95. 95
96. 96
97. 97
98. 98
99. 99
100. 100
101. 101
102. 102
103. 103
104. 104
105. 105
106. 106
107. 107
108. 108
109. 109
110. 110
111. 111
112. 112
113. 113
114. 114
115. 115
116. 116
117. 117
118. 118
119. 119
120. 120
121. 121
122. 122
123. 123
124. 124
125. 125
126. 126
127. 127
128. 128
129. 129
130. 130
131. 131
132. 132
133. 133
134. 134
135. 135
136. 136
137. 137
138. 138
139. 139
140. 140
141. 141
142. 142
143. 143
144. 144
145. 145
146. 146
147. 147
148. 148
149. 149

<!--
Copyright 2025 Shota FUJI

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

SPDX-License-Identifier: Apache-2.0
-->

# Plac for GTK4

Third-party [Roon](https://roon.app/) client application using GTK4 and GNOME widgets.

![Screenshot of Plac for GTK4](./assets/screenshot-gtk-adwaita.png)

## Installation

### Flatpak

1. Go to [Releases page](https://codeberg.org/pocka/plac-for-gtk4/releases)
2. Download `jp.pocka.plac.gtk-adwaita.x86_64.flatpak`
3. Install with `flatpak install --user <path to downloaded file>`

### Nix

Add this repository to Flake inputs then use `packages.${system}.default` in package list.

### Home Manager

Add this repository to Flake inputs then import `homeManagerModules.default`.

```nix
{
  inputs = {
  # ...
    plac = {
      url = "git+https://codeberg.org/pocka/plac-for-gtk4.git";
      inputs.nixpkgs.follows = "nixpkgs";
    };
  };

  outputs = { home-manager, plac, ... }: {
    homeConfigurations = {
      foo = home-manager.lib.homeManagerConfiguration {
        modules = [ plac.homeManagerModules.default ];
      };
    };
  };
}
```

The module is enabled by default.
See [`flake.nix`](./flake.nix) for available options.

## Runtime Dependencies

- gtk4
- libadwaita
- libjpeg
- librsvg
- libgee
- libsoup 3.x

## License

This project is licensed under [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
This project contains asset files licensed under [CC0-1.0](https://creativecommons.org/publicdomain/zero/1.0/legalcode.en).

Every file has [REUSE][reuse-license] annotation for copyright and license.

## Development

### System Dependencies

This project has `flake.nix` for development environment setup.
To start development shell, run:

```
nix develop
```

To develop without [Nix](https://nixos.org/) [Flakes](https://wiki.nixos.org/wiki/Flakes), install these softwares manually:

- Zig compiler v0.16
- Vala compiler v0.56
- pkg-config
- Runtime dependencies

### Running application

```
zig build run
```

### Enable debug logging

Add `Plac` to `G_MESSAGES_DEBUG` environment variable:

```
G_MESSAGES_DEBUG=Plac zig build run
```

### Code Formatting

This project uses [dprint](https://dprint.dev/) as a code formatter frontend.
In addition to system dependencies, you need these formatter softwares:

- dprint
- Uncrustify
- nixfmt

After installing required softwares, you can format source code by:

```
dprint fmt
```

If you're using Nix, use can simply run `nix fmt` without installing anything.

### Build Flatpak bundle

This project provides Zig build script for building Flatpak single-file bundle.
Enter `nix develop .#flatpak` or install `flatpak` and `flatpak-builder`, then run:

```
zig build flatpak
```

This will produce `jp.pocka.plac.gtk-adwaita.flatpak` inside `zig-out` directory.

### License Checking

This project adheres to [REUSE][reuse-license] framework.
You can check files have valid REUSE annotations by:

```
reuse lint
```

[reuse-license]: https://reuse.software/