iOS Compatibility

[swoolcock]

Solution/projects/changes to run osu!lazer on iOS devices.

• Depends on Add iOS Compatibility osu-framework#1409

Tasks:

• Login

• Chat

• osu!direct search and downloads

• osu!standard gameplay

• osu!taiko gameplay

• Non-ruleset visual tests

• Depends on Fix remaining cases of not using host-created TextureLoaderStore #4147

• Depends on Dont always focus textboxes #4153

• Depends on Fix global idle state being entered when overlays are visible #3919

To be done post-merge:

• osu!mania gameplay (except hold notes)
• osu!catch gameplay (see below)
• Ruleset visual tests (see below)

Issues:

• osu!standard spinners crash the app at the end of the spinner unless you don't spin it at all
• Anything using BufferedContainers, due to issues outlined in the osu!framework PR
• Currently can't implement osu!mania hold notes or osu!catch (need to do some hacks to listen for individual key up/down events, as iOS does not expose them)
• Ruleset visual tests not currently building
• Visual tests that require file system access may not run due to permissions or non-existent files

[MiraiSubject]

I have almost been able to compile this version for iOS. However, I've been running in issues with Sixlabors/Core (and Imagesharp) versions that are not available on NuGet.

Specifically speaking these entries in osu.iOS/packages.config:

<package id="SixLabors.Core" version="1.0.0-dev000094" targetFramework="xamarinios10" /><package id="SixLabors.ImageSharp" version="1.0.0-dev002298" targetFramework="xamarinios10"/>

On my copy of the solution I have been able to make some progress by using this ImageSharp version instead. I have still been unsuccessful in getting the Sixlabors/Core properly linked because of this dependency issue I am having.

For context, I've been using 62c4bc9 (master at the time of writing) of ppy/osu-framework for the build process.

osu.Desktop builds and runs successfully so it's isolated to the iOS build.

[naoey]

@MiraiSubject you need to add the myget feed to your nuget sources (https://www.myget.org/F/sixlabors/api/v3/index.json)

[MiraiSubject]

Thanks! @naoey I didn't think about that. Got it running on the 2018 iPad Pro now. Going to be looking into contributing now that I got this build working.

Update:

Wasn't able to get everything from the PR working, am still investigating.
Got the following working though:

• Login
• Chat
• osu!direct search and downloads

In osu!standard the game does not do anything after the spinner finishes on the loading screen for a beatmap. Sometimes the game thread locks up and other times you can still interact with the elements. Audio will always play depending on the length of the song.

Unfortunately, the debugger isn't helping a lot either, providing no useful info. Pausing the execution only vaguely points to osuTK, but osuTK is a black box in context of the project.

[swoolcock]

In osu!standard the game does not do anything after the spinner finishes on the loading screen for a beatmap.

This is to do with hovering not being detected, and was fixed in ppy/osu-framework#2039

Sometimes the game thread locks up and other times you can still interact with the elements.

I noticed this recently, it's something context-related I think. The draw thread runs fine, but SwapBuffers seems to do nothing. I'll make a ticket for it in the framework.

[peppy]

is this because of some incompatible tests?

[swoolcock]

For the unit tests to be discovered, they need to be in the executing assembly, it seems. This means I couldn't split the tests into common, desktop and iOS projects. Instead, I made an iOS project that directly links to the source and compiles with the same root namespace.

[peppy]

I think it's probably best to not do this, as it's 100% going to get forgotten when we add a new folder or namespace.

[swoolcock]

I wasn't particularly happy with it either. Another option I thought of is to include *.cs across the entire project, then exclude anything it puts in the build directory.

[peppy]

I'd definitely prefer this as a slightly better solution. Strongly against specifically listing directories/tests.

[peppy]

I've probably asked this already, but are osu.iOS/libbass.a still required locally?

[swoolcock]

They are currently required, because of the explicit exclusion of NativeLibs in the iOS project. Otherwise mtouch will try to link against libraries that are not supported for iOS. We can potentially solve this by configuring NativeLibs to provide libraries based on target platform.