Skip to content

Commit 67a9eea

Browse files
Add local build instructions (#196)
1 parent e378db7 commit 67a9eea

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/flatpak-maintenance.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,19 @@ One thing to note, is that we are using self contained builds in the Flatpak, so
5454

5555
These are required for .NET self contained builds, but are not generated by that tool. If there is an updated version of those it should be as simple as replacing the version numbers in the URL and then just downloading it to check what the sha512sum of the file is locally.
5656

57+
## Building locally
58+
You'll need the [flatpak-builder](https://docs.flatpak.org/en/latest/flatpak-builder.html) tools installed.
59+
60+
In the Flatpak package repo you have checked out you can run this:
61+
```
62+
flatpak-builder ./build org.unitystation.StationHub.yaml --install --user --force-clean
63+
```
64+
65+
Once that completes it'll be installed it locally for your user, and you can launch it with:
66+
```
67+
flatpak run org.unitystation.StationHub --user
68+
```
69+
5770
## Other info
5871
### Permissions
5972
Flatpaks have a permissions system, in `org.unitystation.StationHub.yaml` we have these permissions setup currently:
@@ -87,5 +100,19 @@ The meta information for the app is specified in the metainfo XML file here: htt
87100
This will be verified as valid before the build is accepted, and the guidelines for this are very strict.
88101
For example, the releases must be specified in newest to oldest order or the build is rejected.
89102

103+
The metainfo can be validated locally by using the following:
104+
```
105+
appstream-util validate org.unitystation.StationHub.metainfo.xml
106+
```
107+
108+
If you get errors like these, they can be ignored.
109+
```
110+
org.unitystation.StationHub.metainfo.xml: FAILED:
111+
• attribute-invalid : <screenshot> width too large [https://unitystationfile.b-cdn.net/screenshots/unitystation-monke.png] maximum is 1600px
112+
• attribute-invalid : <screenshot> height too large [https://unitystationfile.b-cdn.net/screenshots/unitystation-monke.png] maximum is 900px
113+
• attribute-invalid : <screenshot> width too large [https://unitystationfile.b-cdn.net/screenshots/cargo-ui.jpg] maximum is 1600px
114+
• attribute-invalid : <screenshot> height too large [https://unitystationfile.b-cdn.net/screenshots/cargo-ui.jpg] maximum is 900px
115+
```
116+
90117
### Desktop entry
91118
The desktop entry is specified in this file: https://github.com/unitystation/stationhub/blob/develop/UnitystationLauncher/Assets/org.unitystation.StationHub.desktop

0 commit comments

Comments
 (0)