Repository Public License
1<!--2ORIX Arcade3File: README.md4Author: Simon-Pierre Boucher5Contact: contact@spboucher.ai6-->7<div align="center">89<img src="docs/brand/logo.svg" alt="ORIX Arcade logo" width="620">1011<br><br>1213<img src="docs/brand/icon.png" alt="ORIX Arcade icon" width="112" height="112">1415# ORIX Arcade1617**Three original arcade games. One thumb. Fully offline.**1819Domino City · Dig to Core · Traffic Mayhem —<br>20a native iPhone arcade with no account, no ads, no tracking and no network code.2122**Author: [Simon-Pierre Boucher](https://www.spboucher.ai)**23242526-6366F1?style=for-the-badge)2728293031323334-007AFF?style=flat-square)3536373839404142434445-10B981?style=flat-square)46-10B981?style=flat-square)47-10B981?style=flat-square)484950[](https://git.spboucher.ai/orix-arcade/commits)51[](https://git.spboucher.ai/orix-arcade/commits)52[](https://git.spboucher.ai/orix-arcade/insights)53[](https://git.spboucher.ai/orix-arcade)54[](https://git.spboucher.ai/orix-arcade)5556</div>5758> **About the badges.** The build and test badges are static: they state what was run by hand on 2026-11-21 (commands and results in [`docs/metrics`](docs/metrics/2026-11-21-simulator.md)). There is no CI pipeline, so nothing here updates by itself. The frame-pacing figure is a simulator measurement, not a device result. The last row is served live by the git forge.5960## Contents6162[The games](#the-games) · [Screenshots](#screenshots) · [Features](#features) · [Architecture](#architecture) · [Setup](#setup) · [Testing](#testing) · [Measured results](#measured-results) · [Privacy](#privacy) · [Known limitations](#known-limitations) · [Roadmap](#roadmap) · [Changelog](#changelog)6364## The games6566| | Game | You do | It has |67|---|---|---|---|68| 🟧 | **Domino City** | Drag back to aim one impulse, release, and watch a miniature skyline topple in a chain reaction. | 15 handcrafted levels, each with a stored reference solution; domino runs, crate towers, rolling balls, ramps, a plank bridge, bullseye switches and gates, tar pits, a trampoline, a crane wrecking ball; 2–3 impulses per level; 3-star goals; one-tap restart. |69| 🟩 | **Dig to Core** | Hold and drag anywhere to steer a drill that digs down by itself. Collect ore, surface, upgrade, dive deeper — the core is at 1,000 m. | Seeded chunk terrain with a guaranteed route; 5 biomes (Loam Gardens, Crystal Caverns, Bone Shale, Magma Veins, Core Mantle); hard rock, steel plates, lava, chaining gas pockets, fuel cells, repair kits, fossils, treasure vaults, 100 m milestones; fuel and hull; 12 upgrades (55 levels); 7 skins. |70| 🟦 | **Traffic Mayhem** | Tap a waiting vehicle to send it through the junction; hold to preview its path in green or red. | 3 junctions (Four Corners, Main Street, Twin Junction); cars, sports cars, buses, trucks, ambulances; six difficulty stages introduced one at a time; three hearts; streak multiplier up to ×5 and close-call bonus; Endless and 60-second Rush. |7172## Screenshots7374All images are captures of the running app on the iPhone 17 Pro simulator (iOS 26.5), taken with `xcrun simctl io … screenshot` or by the UI tests while the games' built-in bots played. None is a mock-up. They were scaled to half size for the repository. Full set: [`docs/screenshots`](docs/screenshots).7576| Lobby | Awards | Settings | Pause |77|---|---|---|---|78| <img src="docs/screenshots/03-lobby-with-progress.png" width="200" alt="Lobby with progress"> | <img src="docs/screenshots/04-awards.png" width="200" alt="Awards"> | <img src="docs/screenshots/05-settings.png" width="200" alt="Settings"> | <img src="docs/screenshots/52-pause-traffic-mayhem.png" width="200" alt="Pause menu"> |7980**Domino City**8182| Level select | Aiming (tutorial) | Bridge Out | Crane Day | Results |83|---|---|---|---|---|84| <img src="docs/screenshots/11-domino-level-select.png" width="160" alt="Domino City level select"> | <img src="docs/screenshots/10-domino-tutorial-aim.png" width="160" alt="Domino City aiming"> | <img src="docs/screenshots/14-domino-level-06-bridge-out.png" width="160" alt="Domino City level 6"> | <img src="docs/screenshots/16-domino-level-09-crane-day.png" width="160" alt="Domino City level 9"> | <img src="docs/screenshots/12-domino-level-01-results.png" width="160" alt="Domino City results"> |8586**Dig to Core**8788| Hangar | Loam Gardens | Bone Shale | Magma Veins | Upgrades | Run summary |89|---|---|---|---|---|---|90| <img src="docs/screenshots/20-dig-hangar.png" width="135" alt="Dig to Core hangar"> | <img src="docs/screenshots/21-dig-loam-gardens-48m.png" width="135" alt="Loam Gardens"> | <img src="docs/screenshots/25-dig-bone-shale.png" width="135" alt="Bone Shale"> | <img src="docs/screenshots/26-dig-magma-veins.png" width="135" alt="Magma Veins"> | <img src="docs/screenshots/23-dig-upgrade-shop.png" width="135" alt="Upgrade shop"> | <img src="docs/screenshots/28-dig-run-summary.png" width="135" alt="Run summary"> |9192**Traffic Mayhem**9394| Junction select | Four Corners | Main Street | Twin Junction | Rush results |95|---|---|---|---|---|96| <img src="docs/screenshots/30-traffic-junction-select.png" width="160" alt="Junction select"> | <img src="docs/screenshots/31-traffic-four-corners.png" width="160" alt="Four Corners"> | <img src="docs/screenshots/32-traffic-main-street.png" width="160" alt="Main Street"> | <img src="docs/screenshots/33-traffic-twin-junction.png" width="160" alt="Twin Junction"> | <img src="docs/screenshots/34-traffic-rush-results.png" width="160" alt="Rush results"> |9798No demo clips are included yet.99100## Features101102- **Lobby** — short skippable logo reveal, three animated game cards with personal best and progress, local dashboard (play time, sessions, awards), recent sessions, "jump back in" after an interrupted game, first-launch welcome, save-recovery notice.103- **Awards** — records per game, 23 achievements, session history.104- **Settings** — music and effects volumes, haptics, screen-shake strength, visual-effects quality (auto / full / light), reduce motion, high contrast, left-handed pause button, save export / import / reset with confirmation.105- **In every game** — tutorial, pause menu with resume / restart / quick audio toggles / quit, automatic pause when the app leaves the foreground, results card with counted-up score, instant retry.106- **Sound and art** — every sprite, sound effect and music loop is generated in code; the repository contains no bitmap art and no audio file. Audio uses the ambient session: it follows the silent switch and does not interrupt your own music.107- **Persistence** — one versioned JSON save with rolling backup; an unreadable save is set aside, never deleted.108109## Architecture110111```mermaid112flowchart TD113 App["App<br/>entry, root navigation, lobby, awards, settings"] --> Core114 App --> DS["DesignSystem<br/>tokens, components, backgrounds, logo"]115 Core["ArcadeCore<br/>GameDescriptor, ArcadeServices, SeededRNG,<br/>ArcadeScene, GameChrome, ResultsCard"] --> AH["AudioHaptics<br/>Synth, AudioDirector, HapticsDirector"]116 Core --> P["Persistence<br/>SaveData, SaveCodec, SaveStore"]117 App --> G1["Games/DominoCity"]118 App --> G2["Games/DigToCore"]119 App --> G3["Games/TrafficMayhem"]120 G1 --> Core121 G2 --> Core122 G3 --> Core123 G1 --> DS124 G2 --> DS125 G3 --> DS126```127128Each game follows the same split, which is what makes it testable:129130```mermaid131flowchart LR132 Rules["Pure Swift rules<br/>(levels, generation, traffic sim, scoring)"] --> Scene["SpriteKit scene<br/>(ArcadeScene subclass)"]133 Scene --> Views["SwiftUI flow<br/>(menu → play → results)"]134 Views --> Save["Save model<br/>(Codable, tolerant decoding)"]135 Rules --> Tests["Unit tests"]136 Bot["Built-in bot<br/>(-ORIXAutoplay)"] --> Scene137```138139| Folder | Lines of Swift | Role |140|---|---:|---|141| `App/` | 756 | entry point, navigation, lobby, awards, settings |142| `DesignSystem/` | 647 | tokens and reusable components |143| `ArcadeCore/` | 892 | shared game contracts, base scene, in-game chrome |144| `AudioHaptics/` | 555 | procedural synth, audio and haptics directors |145| `Persistence/` | 311 | save model and store |146| `Games/DominoCity/` | 2,262 | physics puzzle |147| `Games/DigToCore/` | 2,852 | procedural digger |148| `Games/TrafficMayhem/` | 2,609 | traffic simulation |149| `Tests/`, `UITests/` | 1,715 | 88 unit tests, 6 UI tests |150151Decisions and their reasons are in [`docs/IMPLEMENTATION_PLAN.md`](docs/IMPLEMENTATION_PLAN.md).152153## Setup154155Requirements: Xcode 27 (built with 27.2), [XcodeGen](https://github.com/yonaskolb/XcodeGen), an iOS 18+ simulator or iPhone. No package to resolve, no key, no server.156157```bash158Scripts/build.sh generate # writes ORIXArcade.xcodeproj from project.yml159open ORIXArcade.xcodeproj # scheme ORIXArcade160```161162Platform support: iPhone only, portrait only, iOS 18.0 or later, dark appearance only. English only.163164Useful launch arguments (Debug and Release): `-ORIXGame dominoCity|digToCore|trafficMayhem`, `-ORIXAutoplay YES`, `-ORIXSeed 42`, `-ORIXLevel N`, `-ORIXDive YES`, `-ORIXLayout N -ORIXMode endless|rush`, `-ORIXSaveName name`, `-ORIXReset YES`, `-ORIXSkipIntro YES`, `-ORIXMute YES`, `-ORIXPerfLog YES`.165166## Testing167168```bash169Scripts/build.sh build # simulator build170Scripts/build.sh test # unit tests (scoring, generation, traffic fairness, persistence, physics solutions)171Scripts/build.sh uitest # UI tests (launch, each game: start, pause, resume, restart, quit, finish, relaunch)172Scripts/screenshots.sh # real captures + frame-time logs173Scripts/secret-scan.sh # refuses keys, profiles and tokens in tracked files174Scripts/release.sh archive|export|validate|upload175```176177The scripts create a dedicated simulator named "ORIXArcade iPhone" (override with `ORIX_SIM`).178179## Measured results180181Simulator only — see [`docs/metrics/2026-11-21-simulator.md`](docs/metrics/2026-11-21-simulator.md) for the environment, the raw logs and everything that was **not** measured.182183| Metric | Target | Measured (simulator, 2026-11-21) | On an iPhone |184|---|---|---|---|185| Frame pacing | 60 fps | 58.5–60.0 fps average, p95 16.67 ms in every scene | not measured |186| Memory footprint | — | 38 MB lobby, 40–53 MB in game (peak 84 MB) | not measured |187| Unit tests | all pass | 88 run, 0 failed, 1 skipped | — |188| UI tests | all pass | 6 run, 0 failed | — |189| Domino City solvability | 15 / 15 | 15 / 15 cleared by the bot in the real app | — |190| Cold launch, battery, thermals | — | not measured | not measured |191192## Privacy193194Nothing is collected. No account, no analytics, no ads, no network code, no permission prompt. Progress lives in one file in the app's container and leaves it only through **Settings › Export save**. Details: [`docs/PRIVACY.md`](docs/PRIVACY.md).195196## Known limitations197198- **Never run on a physical iPhone.** Touch feel, haptics, speaker output, 120 Hz and real frame rates are unverified. All gameplay verification was done by bots on the simulator; no human playtest has tuned the difficulty.199- Domino City uses SpriteKit physics, which is reproducible in practice but not bit-exact; several levels were confirmed only at their reference shot. Any level can also be cleared with a direct lob onto the target, for fewer stars.200- Traffic Mayhem: an idle player can lose all three hearts within seconds of each other; the top difficulty was tuned by estimate.201- Dig to Core: once every upgrade is bought, credits have no further use.202- The games themselves are not playable with VoiceOver (menus, results and settings are labelled). Small-screen layouts and Dynamic Type extremes were not checked.203- English only. No iPad layout. No demo video.204- Resuming restores the game you were in, not the exact moment of an interrupted run.205206## Roadmap2072081. Device pass on an iPhone: feel, haptics, audio mix, frame rates, thermals; then difficulty tuning from real play.2092. French localisation.2103. Daily seeded challenges for Dig to Core and Traffic Mayhem.2114. More Domino City blocks and a level-solution tolerance sweep at 120 Hz.2125. Mid-run resume for Dig to Core.213214## Changelog215216- **0.1.0 (1)** — 2026-11-21 — first milestone: lobby, awards, settings, Domino City, Dig to Core, Traffic Mayhem. [Release notes](docs/release-notes/v0.1.0.md).217218## Author219220**Simon-Pierre Boucher** — [spboucher.ai](https://www.spboucher.ai) — contact@spboucher.ai221222© 2026 Simon-Pierre Boucher. All rights reserved; see [`LICENSE`](LICENSE).223