diff --git a/release-plans.md b/release-plans.md new file mode 100644 index 0000000..c6e2345 --- /dev/null +++ b/release-plans.md @@ -0,0 +1,77 @@ +## Upcoming +----- + +**0.7** will be Atmosphère's first official release. It will be released following the resolution of the remaining [0.7 Milestone issues](https://github.com/Atmosphere-NX/Atmosphere/issues?q=is%3Aopen+is%3Aissue+milestone%3A0.7). + +Current best estimate for 0.7's release is August, 2018. + +It will support the following featureset: + +* **Fusée**, a custom bootloader. + * Supports loading/customizing of arbitrary KIPs from the SD card. + * Supports compile-time defined kernel patches on a per-firmware basis. + * Configurable by editing `BCT.ini` on the SD card. + * Atmosphère should also be launchable by the alternative [hekate](https://github.com/CTCaer/hekate) bootloader, for those who prefer it. +* **Exosphère**, a fully-featured custom secure monitor. + * Exosphere is a re-implementation of Nintendo's TrustZone firmware, fully replicating all of its features. + * In addition, it has been extended to provide information on current Atmosphere API version, for homebrew wishing to make use of it. +* **Stratosphère**, a set of custom system modules. This includes: + * A **loader** system module. + * Reimplementation of Nintendo's loader, fully replicating all original functionality. + * Extended to support arbitrary redirection of executable content to the SD card. + * Files will be preferentially loaded from `/atmosphere/titles//exefs/`, if present. + * Files present in the original exefs a user wants to mark as not present may be "stubbed" by creating a .stub file on the SD. + * If present, a PFS0 at `/atmosphere/titles//exefs.nsp` will fully replace the original exefs on 2.0.0+ + * Redirection will be optionally togglable by holding down certain buttons. + * Full support for patching NSO content is implemented. + * All patches at paths like `/atmosphere/exefs_patches//.ips` will be applied, allowing for easy distribution of patches supporting multiple firmare versions and/or titles. + * Both the IPS and IPS32 formats are supported. + * Extended to support launching content from loose executable files on the SD card, without requiring any official installation. + * This is done by specifying `FsStorageId_None` on launch. + * A **service manager** system module. + * Reimplementation of Nintendo's service manager, fully replicating all original functionality. + * Compile-time support for reintroduction of "smhax", allowing clients to optionally skip service access verification by skipping initialization. + * Extended to allow homebrew to acquire more handles to privileged services than Nintendo natively allows. + * Extended to add a new API for installing Man-In-The-Middle listeners for arbitrary services. + * API can additionally be used to safely detect whether a service has been registered in a non-blocking way with no side-effects. + * Full API documentation to come. + * A **process manager** system module. + * Reimplementation of Nintendo's process manager, fully replicating all original functionality. + * Extended to allow homebrew to acquire handles to arbitrary processes, and thus read/modify system memory without blocking execution. + * Extended by embedding a full, extended implementation of Nintendo's **boot2** system module. + * Title launch order has been optimized in order to grant access to the SD card faster. + * The error-collection system module is intentionally not launched, preventing many system telemetry error reports from being generated at all. + * Users may place their own custom sysmodules on the SD card and flag them for automatic boot2 launch by creating a `/atmosphere/titles//boot2.flag` file on their SD card. + * A custom **fs.mitm** system module. + * Uses Atmosphère's MitM API in order to provide an easy means for users to modify game content. + * Intercepts all FS commands sent by games, with special handling for commands used to mount RomFS/DLC content to enable easy creation and distribution of game/DLC mods. + * fs.mitm will parse the base RomFS image for a game, a RomFS image located at `/atmosphere/titles/<title ID>/romfs.bin`, and all loose files in `/atmosphere/titles/<title ID>/romfs/`, and merge them together into a single RomFS image. + * When merging, loose files are preferred to content in the SD card romfs.bin image, and files from the SD card image are preferred to those in the base image. + * Can additionally be used to intercept commands sent by arbitrary system titles (excepting those launched before SD card is active), by creating a `/atmosphere/titles/<title ID>/fsmitm.flag` file on the SD card. + * A custom **crash report** system module. + * Serves as a drop-in replacement for Nintendo's own creport system module. + * Generates detailed, human-readable reports on system crashes, saving to `/atmosphere/crash_reports/<timestamp>_<title ID>.log`. + * Because reports are not sent to the `erpt` sysmodule, this disables all crash report related telemetry. +* General system stability improvements to enhance the user's experience. + +## Planned +----- + +There are a number of features planned for inclusion Atmosphère that won't make the cut for 0.7's release. As they are implemented, Atmosphère's release version will tick upward from 0.7 to 0.8 to 0.9, and finally 1.0. + +These currently planned features include (but aren't limited to): +* **Thermosphère**, a hypervisor-based emunand implementation. +* A feature-rich debugging toolset (a component of Stratosphère). + * A custom **debug monitor** system module, providing an API for debugging Switch's processes. This may not be a reimplementation of Nintendo's own debug monitor. + * This should include a gdbstub implementation, possibly borrowing from Luma3DS's. + * This API should be additionally usable for RAM Editing/"Cheat Engine" purposes. + * A custom **shell** system module, providing an means for users to perform various RPC (with support for common/interesting functionality) on their Switch remotely. This may not be a reimplementation of Nintendo's own shell. + * This should support client connections over both Wi-Fi and USB. + * A custom **logging** system module, providing an means for other Atmosphère components (and possibly Nintendo's own system modules) to log debug output. + * This should support logging to the SD card, over Wi-Fi, and over USB. +* An application-level plugin system. + * This will, ideally, work somewhat like NTR-CFW's plugin system on the 3DS, allowing users to run their own code in a game's process in their own thread. +* An AR Code/Gameshark analog implementation, allowing for easy sharing/development of cheat codes to run on device. +* Further extensions to existing Atmosphère components. +* General system stability improvements to enhance the user's experience. +