https://github.com/madsmtm/ruffle-ios
Ruffle Flash Player emulator on iOS
https://github.com/madsmtm/ruffle-ios
emulator flash ios objc2 ruffle rust rust-lang swf uikit
Last synced: 19 days ago
JSON representation
Ruffle Flash Player emulator on iOS
- Host: GitHub
- URL: https://github.com/madsmtm/ruffle-ios
- Owner: madsmtm
- License: other
- Created: 2024-09-16T15:11:10.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-08T09:54:09.000Z (3 months ago)
- Last Synced: 2025-03-24T00:38:11.955Z (about 1 month ago)
- Topics: emulator, flash, ios, objc2, ruffle, rust, rust-lang, swf, uikit
- Language: Rust
- Homepage:
- Size: 608 KB
- Stars: 9
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# The Ruffle Flash Player emulator on iOS
Work in progress.
See [ruffle.rs](https://ruffle.rs/) for a general introduction.
## Design choices
A normal person might have wrapped the Rust in some `extern "C" fn`s, and then used SwiftUI, or at least Objective-C for the UI shell. I would probably recommend that for most use-cases.
I'm developing [`objc2`](https://github.com/madsmtm/objc2) though, and I want to improve the user-interface of that, so I decided to be a bit unortodox, and do everything in Rust.
## Testing
Run the core player on Mac Catalyst with:
```
cargo bundle --target=aarch64-apple-ios-macabi --bin run_swf && ./target/aarch64-apple-ios-macabi/debug/bundle/ios/Ruffle.app/run_swf
```
The proper application can also be launched from the iOS Simulator by opening [the Xcode project](./ruffle-ios.xcodeproj).
To open an SWF/Ruffle bundle, simply drag and drop the `.swf`/`.ruf` onto the simulator window, see:
https://developer.apple.com/documentation/xcode/sharing-data-with-simulator
NOTE: The simulator has to have read permissions for the file, you may have to place it outside the `Desktop`/`Documents`/... folders, which require special permission setup.
## UI
Similar to https://getutm.app/, we should have:
- A library of "installed" SWFs/bundles/saved links, editable.
- When selecting an SWF, the navigation bar at the top shows various options
- Opening keyboard (maybe?)
- Context menu "play, rewind, forward, back, etc."?
- Allow changing between scale
- Back button to go back to library
- "Add" and "edit" are two different flows, and should show two different UIs
- "Add" doesn't have to show all the extra settings; it is only about getting the file. The user can edit it later.
## Library item settings
Settings are stored per Ruffle Bundle.
- `PlayerOptions`
- https://github.com/ruffle-rs/ruffle/blob/master/frontend-utils/src/bundle/README.md#player
- Inputs:
- Configurable
- Swipe for arrow keys?
- https://openemu.org/ does it pretty well, equivalent for iOS?
- Custom name?
- Custom image?
## Storage
We do not store Ruffle Bundles / SWFs, the user is responsible for doing that themselves in the Files app. We only store "bookmarks" to these, to allow easily re-opening from within the app, and to store user data.
This can be synced to iCloud, though the user may have to re-select the referenced Ruffle Bundle (in case it was stored locally, and not in iCloud).
Goal: Be backwards and forwards compatible with new versions of the Ruffle app.
- Upheld for [Ruffle Bundles](https://discord.com/channels/610531541889581066/1225519553916829736/1232031955751665777).
- Should also be fine for user settings.
See [src/storage.rs] for implementation.
## Terminology
What do we call an SWF / a Ruffle Bundle? "Game"? "Movie"? "SWF"? "Flash Animation"?
Internally: "movie".
## Plan
1. Get the Ruffle UI running in a `UIView`
2. Wire up some way to start it using an SWF on the local device
## TODO
- Set `idleTimerDisabled` at the appropriate time
- Use white for labels, orange for buttons
- Add settings button in library item
- Add quicklook thumbnail generator app extension
- Figure out what `UIDocument` actually does?
- Ensure that CoreData stores a bookmark of the NSURL, and if not, do that ourselves.
- https://developer.apple.com/documentation/foundation/nsurl/1417795-bookmarkdatawithoptions?language=objc
- https://developer.apple.com/documentation/foundation/nsurl/1408532-writebookmarkdata?language=objc
- Sync
- https://developer.apple.com/documentation/xcode/configuring-icloud-services?language=objc
- https://developer.apple.com/documentation/foundation/optimizing_your_app_s_data_for_icloud_backup?language=objc
- https://developer.apple.com/library/archive/documentation/General/Conceptual/iCloudDesignGuide/Chapters/DesigningForDocumentsIniCloud.html#//apple_ref/doc/uid/TP40012094-CH2
- https://developer.apple.com/documentation/uikit/synchronizing-documents-in-the-icloud-environment?language=objc
## Choices
- Intentionally use `public.app-category.games` to get better performance ("Game Mode" on macOS).
- This is not necessarily the correct choice for Ruffle, but it's the closest.
- It doesn't make sense to have root settings like in the desktop version
- No tab bar, not really desired, since we generally want the SWF's UI to fill most of the screen
- Though if we decide to add an easy way to download from "trusted" sources, we could add a tab bar for that
- A navigation bar is useful though
- To display some settings for the current swf
- To go back to library
- Hide when entering full screen?