diff --git a/README.md b/README.md index d78b543..4327a60 100644 --- a/README.md +++ b/README.md @@ -14,28 +14,60 @@ It enhances the osu! experience with quality-of-life features and integration sp ## πŸš€ Features - [x] Automatically updates osu! before launching -- [x] Automatically start/stop the OpenTabletDriver Daemon +- [x] Automatically start/stop the OpenTabletDriver Daemon (Windows) - [x] Automatic ingame login -- [x] Patches the osu! client to show misses in Relax and Autopilot +- [x] Patches the osu! client to show misses in Relax and Autopilot (Windows, Linux and macOS via Wine) - [x] Displays your EZPPFarm stats in the launcher - [x] Shows the number of imported beatmapsets - [x] Shows the number of imported skins - [x] Displays ping to the EZPPFarm server - [x] Discord Rich Presence - [x] Performance Display Overlay (currently in experimental patcher release stream) -- [x] Launcher Theming +- [x] Launcher Theming (API 1.0 bundles and API 2.0 declarative themes) +- [x] Advanced theme editor in its own window with freeform text/image/video/shape layers, fonts, live launcher preview and export --- ## πŸ’» Supported Platforms -| Platform | Status | -| -------- | ---------------------------------------- | -| Windows | βœ… Supported | -| macOS | ❌ Not supported | -| Linux | πŸ•§ Partially supported (via osu-winello) | +| Platform | Status | +| -------- | ------------------------------------------------------ | +| Windows | βœ… Supported | +| macOS | πŸ•§ Partially supported (via Wineskin/Whisky/CrossOver) | +| Linux | πŸ•§ Partially supported (via osu-winello) | -> Currently, only **Windows** is fully supported. Support for other platforms may be considered in the future. +> **Windows** remains the fully supported platform. OpenTabletDriver is Windows-only. On macOS, +> in-game patching runs the Windows patcher through the same Wine prefix as osu!, so that prefix +> needs a .NET runtime installed. + +### macOS + +osu! stable is a Windows build, so on macOS it runs inside a Wine wrapper. EZPPLauncher +supports Wineskin wrappers (the usual `osu!.app` wine skin), Whisky bottles and CrossOver +bottles. + +The setup wizard automatically looks for Wineskins in `/Applications` and `~/Applications`. +If detection fails, choose **Browse** and pick the `osu!.app` wrapper itself (or a Wine prefix +folder); the launcher resolves the osu! installation inside it, so there is no need to open the +bundle's package contents. + +--- + +## πŸͺ΅ Logs + +Launcher, osu! and patcher output is written to `.ezpplauncher/logs` in your home folder: + +| File | Contents | +| -------------- | -------------------------------------------------------------- | +| `launcher.log` | Launcher lifecycle, webview console output and uncaught errors | +| `osu.log` | osu! and osu! updater output, including stdout/stderr | +| `patcher.log` | Patcher output, including stdout/stderr | + +A file is only created when that stream actually writes a line. On each new session, or when +any file reaches 5 MiB, all three active files are bundled into a single +`logs__