ppy / osu-deploy

Deploy script for lazer

osu-deploy

Deploy task for osu!lazer.

This is what creates installable copies of lazer.

Made for internal use; as such documentation is not provided. YMMV.

Licence

The osu! client code, framework, and tools are licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

Please note that this does not cover the usage of the "osu!" or "ppy" branding in any software, resources, advertising or promotion, as this is protected by trademark law.

osu-deploy's Issues

Build 32-bit binaries

Would fix ppy/osu#3984.

Proposed design: If deploying for windows, also dotnet publish for win-x86 architecture. .32 or similar can be inserted between filename and extension for 32-bit builds.

Not signing

I have poco f3 gt and when i want to sign in to osu anything i write doesn't even show. It just doesn't.

Linux releases are not code signed

They probably should be.

Improve icons support on Linux

The icon packaged in the AppDir is probably a little too big (1024x1024), additionally proper desktop integration seems to fail when the icons are not available in the usual expected location which is normally /usr/share/icons/hicolor.

hicolor is simply the 'default' theme, since there is the concept of icon themes and other themes can apply a custom icon override if desired but hicolor is where apps install their default icons.

Currently integration with AppImageLauncher shows no icon for osu! and I have verified the same issue on other immature appimages that also failed to provide the additional icons in the expected directory (/usr/share/icons) where as major applications like Krita does so correctly.

Technically the AppImageLauncher is supposed to use the base AppDir icon and re-size it but it seems to be bugged

─❯ ail-cli integrate osu.AppImage                                            ─╯
Processing /home/ravener/osu.AppImage
Moving AppImage to integration directory
WARNING: No icons found at "usr/share/icons"
WARNING: Using .DirIcon as default app icon
ERROR: Unable to load image.
ERROR: No icon was generated for: /home/ravener/Applications/osu_e72e7ca7eb9bb530405a0f8263c2a923.AppImage
WARNING: Unable to resize the application icon into a 128x128 image: "Unable to load image.". It will be written unchanged.
WARNING: Unable to resize the application icon into a 256x256 image: "Unable to load image.". It will be written unchanged.

This happens to every app, so it's partly the tool's fault?. Yet many of the mature AppImages in the ecosystem like Krita and others do opt to put their icons in /usr/share/icons and that's typically how native packages do it, so not only does it workaround this bug with the tool but it just overall improves the general package structure to be more standard.

Let's take Krita as our example here on how to do it:

• The base icon in the AppDir is 256x256 (ours seems too large relative to most apps I've seen, for comparison the bare minimum size recommended is 48x48)
• There is additional krita icons in /usr/share/icons/hicolor/[size]/apps/krita.png
• This means we need to provide additional icon sizes, just like how it's needed for other platforms. (i.e Android's drawable-xxhdpi, etc)
• Krita provides icons for 16x16, 22x22, 32x32, 48x48, 64x64, 128x128, 256x256, 512x512, 1024x1024, scalable (There are even more size options available if needed)

• scalable can contain vector files like .svg if possible, krita opted to include a .svgz (compressed SVG) but this is completely optional.

So in summary we should start including other size icons in /usr/share/icons/hicolor/[size]/apps/osu!.png inside the AppDir and I also recommend using a smaller size icon for the base AppDir icon that we currently have since 1024x1024 seems too unnecessarily large and we can have a 1024x1024 version of the icon in the aforementioned directories.

I would lend a hand in submitting a PR and such but I would like to hear from you first and I have no idea how do you prefer the icon resizing to be handled and which of the sizes will we choose to provide?

Please remove Terminal=true from osu!.desktop

Please remove the line Terminal=true from osu!.desktop. This causes other programs such as AppImageLauncher to mistake osu!lazer for a terminal application. This results in issues such as TheAssassin/AppImageLauncher#399, where AppImageLauncher does not offer to integrate osu!lazer.AppImage into the system.

Version information should be embedded in Linux AppImages

AppImages support a X-AppImage-Version field in the .desktop file to embed version information on the appimage, this is used by desktop integration solutions such as AppImageLauncher in which it adds the version information on to the name of the app in the application list. e.g "AppName (1.0.0)" where the version is picked up from the X-AppImage-Version property.

I've seen all major appimages come with this property but not osu!, currently that desktop integration thing ends up making osu appear as "osu! (1)" since version information is missing.

You do not need to add this field into the .desktop file manually as the appimagetool seems to support adding this automatically on presence of the $VERSION variable as seen here

Windows build should be packable via `dotnet pack`

This is just to document my findings for if they're needed in the future.

The windows build currently uses nuget.exe to make the resultant package. It should use dotnet pack instead since nuget.exe is deprecated. So are some of the options in the .nuspec such as iconUrl and the net45 target for files (we don't use net45).

The following seems to work:

diff --git a/osu.Desktop/osu.Desktop.csproj b/osu.Desktop/osu.Desktop.csproj
index a4f9e2671b..7f10246946 100644
--- a/osu.Desktop/osu.Desktop.csproj
+++ b/osu.Desktop/osu.Desktop.csproj
@@ -11,6 +11,7 @@
     <ApplicationManifest>app.manifest</ApplicationManifest>
     <Version>0.0.0</Version>
     <FileVersion>0.0.0</FileVersion>
+    <IsPackable>true</IsPackable>
   </PropertyGroup>
   <PropertyGroup>
     <StartupObject>osu.Desktop.Program</StartupObject>
diff --git a/osu.Desktop/osu.nuspec b/osu.Desktop/osu.nuspec
index db58c325bd..898110b6a8 100644
--- a/osu.Desktop/osu.nuspec
+++ b/osu.Desktop/osu.nuspec
@@ -7,17 +7,20 @@
         <authors>ppy Pty Ltd</authors>
         <owners>Dean Herbert</owners>
         <projectUrl>https://osu.ppy.sh/</projectUrl>
-        <iconUrl>https://puu.sh/tYyXZ/9a01a5d1b0.ico</iconUrl>
         <requireLicenseAcceptance>false</requireLicenseAcceptance>
         <description>A free-to-win rhythm game. Rhythm is just a *click* away!</description>
         <releaseNotes>testing</releaseNotes>
         <copyright>Copyright (c) 2022 ppy Pty Ltd</copyright>
         <language>en-AU</language>
+        <dependencies>
+            <group targetFramework=".NET6.0"/>
+        </dependencies>
     </metadata>
     <files>
-      <file src="**.exe" target="lib\net45\" exclude="**vshost**"/>
-      <file src="**.dll" target="lib\net45\"/>
-      <file src="**.config" target="lib\net45\"/>
-      <file src="**.json" target="lib\net45\"/>
+      <file src="**.exe" target="lib\net6.0\" exclude="**vshost**"/>
+      <file src="**.dll" target="lib\net6.0\"/>
+      <file src="**.config" target="lib\net6.0\"/>
+      <file src="**.json" target="lib\net6.0\"/>
     </files>
 </package>

dotnet publish -c:Release -r:win-x64 -o out
dotnet pack --no-build --no-restore -c:Release -p:NuspecFile=osu.nuspec -p:NuspecBasePath=out

However, .nuspec itself is deprecated when using dotnet pack, so these should all be moved into the .csproj (and would remove the requirement for <IsPackable>).

xcrun altool may get stuck due to "need to sign contracts"

Apple pushes new contracts and they break the ability to use developer tools.

The deploy script doesn't surface these errors currently, and instead looks like it has hung indefinitely. Probably an stdout/stderr issue.

osu!lazer (Android) failing to connect to the account.