Mirrors/uLaunch
2
0
Fork 0
mirror of https://github.com/XorTroll/uLaunch synced 2025-02-16 20:48:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve README

Browse source
This commit is contained in:
XorTroll 2019-11-10 17:23:35 +01:00
parent 13ce6db49a
commit a7ae5c9a25
2 changed files with 101 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

139
README.md
View file

@ -1,6 +1,6 @@
<img width="200" src="LibraryAppletQMenu/RomFs/LogoLarge.png">
> Custom, open-source replacement/reimplementation for Nintendo Switch's HOME Menu (qlaunch), extending it with amazing, homebrew-orienteed functionality!
> Custom, open-source replacement/reimplementation for Nintendo Switch's HOME menu (qlaunch), extending it with amazing, homebrew-orienteed functionality!
<img src="Screenshots/s1.png" alt="drawing" width="400"/> <img src="Screenshots/s2.png" alt="drawing" width="400"/>
@ -8,33 +8,66 @@
<img src="Screenshots/s5.png" alt="drawing" width="400"/> <img src="Screenshots/s6.png" alt="drawing" width="400"/>
uLaunch is a very ambicious project, consisting on two custom library applets, a custom system application and a custom system applet, in order to replace the console's **HOME menu** with a custom, homebrew-orienteed one.
uLaunch is a very ambitious project, consisting on two custom library applets, a custom system application and a custom system applet, in order to replace the console's **HOME menu** with a custom, homebrew-orienteed one.
No, this isn't any kind of HOME menu extension, injection, patch, etc. uLaunch is a **complete** reimplementation, 100% open-source, which also takes over eShop and Mii applets and flog system title, for its extended functionality.
## **NOTE:** the project is still a work-in-progress. Check what's left to do before release [here](TODO.md)!
- This isn't any kind of HOME menu extension, injection, patch, etc. uLaunch is a **complete** reimplementation, 100% open-source, which also takes over eShop and Parental control applets and flog system title (all of them are pretty much useless with this reimpl) for its extended functionality.
- The project is licensed as **GPLv2**.
- For those who are interested in how the UI was done, this project is, like [Goldleaf](https://github.com/XorTroll/Goldleaf), a good example of how powerful [Plutonium libraries](https://github.com/XorTroll/Plutonium) can be in order to make beautiful UIs.
## Are you looking for help with themes? Check [this document](Themes.md) for more info!
## Are you looking for help with themes? Check [this documentation](Themes.md) for everything you need!
## Having trouble with uLaunch? Check the [FAQ](#faq) section for support!
### **Table of contents**
1. [Features](#features)
2. [Disclaimer](#disclaimer)
3. [Project and subprojects](#project-and-subprojects)
4. [Custom menu entries](#custom-menu-entries)
5. [Translations](#translations)
6. [Installing and removing](#installing-and-removing)
7. [Compiling](#compiling)
8. [Errors](#errors)
9. [Credits](#credits)
3. [FAQ](#faq)
4. [Project and subprojects](#project-and-subprojects)
5. [Custom menu entries](#custom-menu-entries)
6. [Translations](#translations)
7. [Installing and removing](#installing-and-removing)
8. [Compiling](#compiling)
9. [Errors](#errors)
10. [Credits](#credits)
## Features
**List of HOME menu features uLaunch has**:
- Proper launching and foreground management: launch, suspend and close titles and applets
- Proper general channel handling (some of it might be not implemented): sleep, shutdown, reboot, HOME menu press detection...
- Settings:
- Show connected WiFi network's name
- Open connection applet in case user wants to change network settings
- Change console's language and show active one
- Change console's nickname and show current one
- User features:
- Allow creating user on the startup menu
- Show user's page (in order to edit nickname, icon, friends...)
**List of not (yet) implemented HOME menu features**:
- Controller managing
- Album
- ~~Periodical play report sending (so long, telemetry!)~~
This is the amount of features uLaunch contains, compared to the original HOME menu:
- Homebrew support
- *Homebrew support*
- Launching as applets (no need of **Album**!)
@ -44,37 +77,47 @@ This is the amount of features uLaunch contains, compared to the original HOME m
- Option to add custom NRO accessors to main menu (homebrew or custom items easily accessible, no more need of **forwarders**!)
- Miscellaneous extras
- Web browsing (via web-applet) directly from the main menu!
- **Foreground capturing** from PC itself (*Windows*-only) via USB-C cable and *QForegroundViewer*!
- UI
- *UI*
- **Themes** (different to official HOME menu themes/NXThemes)
- Custom icons, menu gfx, background...
- Custom icons, menu assets and graphics (custom images, colors, sizes, positions...), background...
- Custom **background music** and **sound effects**!
- **Folders** in order to keep your main menu organized!
- Option to show the suspended title in the **background** (like 3DS's HOME menu did!)
- Users
- *Users*
- PC-like login on startup (select user and use it for everything, log off, register/change/remove password...)
- **User password** support! (up to 15 characters)
- *Miscellaneous extras*
- Web browsing (via web-applet) directly from the main menu!
- **Foreground capturing** from PC itself (*Windows*-only) via USB-C cable and *QForegroundViewer*!
## Disclaimer
### Homebrew-as-application 'flog' takeover
uLaunch launches homebrew present (added) to main menu as an application, taking advantage of the system's '**flog**' built-in application title, which was stubbed but not removed, thus it's content can be overriden via LayeredFS and launched.
uLaunch allows you to launch homebrew as an application, taking advantage of the system's '**flog**' built-in application title, which was stubbed but not removed, thus it's content can be overriden via LayeredFS and launched.
Since launching this title should be impossible, it might involve ban risk. uLaunch has this option **disabled by default**, so enable and use it **use it at your own risk**.
Since launching this title should be impossible, it might involve ban risk. uLaunch has this option **disabled by default**, so enable and use it **use it at your own risk**. Always make youre you're safe from bans (by using tools like 90DNS) before using uLaunch to avoid any possible risks.
## FAQ
- *How do I uninstall installed titles? How do I delete user accounts?*
- uLaunch doesn't (and won't) support these, since there is already existing homebrew serving as title or user managers, like [Goldleaf](https://github.com/XorTroll/Goldleaf).
- *How can I change my controllers, access eShop or view the album?*
- These are all TODOs for uLaunch (not yet supported), except eShop, which for what it's worth, won't be supported. If you want to use eShop, remove uLaunch and use the original HOME menu.
> TODO: add more FAQs here
## Project and subprojects
@ -88,9 +131,9 @@ This is the technically actual qlaunch reimplementation. In fact, it is used as
### QMenu (LibraryAppletQMenu)
> This sub-project replaces "cabinet" library applet, aka title 010000000000100B.
> This sub-project uses eShop's library applet as a donor title, aka 010000000000100B.
This is the HOME menu the user will see and interact with. It contains all the UI and sounc functionality, password, themes...
This is the "actual" HOME menu the user will see and interact with. It contains all the UI and sounc functionality, password, themes...
### QHbTarget
@ -110,7 +153,9 @@ This is the same process but, like in normal HOME menu and Album, it runs homebr
### QForegroundViewer
*QDaemon* daemon process, appart from usual (and special) HOME menu functions, it also sends the console's foreground display via USB as a raw RGBA8 1280x720 ~3MB buffer. **QForegroundViewer** is the PC tool (WinForms) which intercepts those sent buffers and renders them. It is a bit laggy, but can be *very* useful for taking quick screenshots!
*QDaemon* backend process, appart from handling HOME menu functionality, also sends the console's foreground display via USB (if enabled on settings) as a raw RGBA8888 1280x720 ~3.5MB buffer. **QForegroundViewer** is the PC tool (Windows Forms) which intercepts those sent buffers and renders them. It is a bit laggy, but can be *very, very* useful for taking quick screenshots!
This option comes disabled by default because homebrew using USB (like Goldleaf or nxmtp) would interfer with the connection. If you really want to use it, enable it from settings.
This tool was used to take the screenshots shown above, all in full 1280x720 quality.
@ -122,11 +167,11 @@ For more technical information about uLaunch and qlaunch, check [this](HOME.md).
uLaunch supports adding custom shortcuts. This means you can show entries with a custom icon, which launch a NRO with certain argv, what could be potentially used for stuff like emulator ROM shorcuts.
Entries consist on JSON files (one per entry) located at `sd:/ulaunch/entries`. They are used for two main purposes:
Entries consist on JSON files (one per entry) located at `sd:/ulaunch/entries` (name doesn't matter, but the extension must be `*.json`!). They are used for two main purposes:
- Adding homebrew accesses (as stated above) to the main menu
- Specifying that a homebrew access or a system title go inside a folder
- Specifying that a homebrew access or a normal, installed game/application go inside a folder
If you want to make your own access, create a JSON file in the entries folder (the name doesn't matter) like this:
@ -135,21 +180,27 @@ If you want to make your own access, create a JSON file in the entries folder (t
"type": 2,
"nro_path": "<path-to-nro>",
"nro_argv": "<custom-argv>",
"icon": "<custom-icon-jpeg>",
"icon": "<custom-icon-256x256>",
"name": "My custom entry",
"author": "Second text for whatever I want",
"version": "Third text"
"name": "Name (511 bytes max.)",
"author": "Author (255 bytex max.)",
"version": "Version (15 bytes max.)"
}
```
Note that type needs to be **always 2**, and that `type`, `nro_path` **must be present**. The others are all optional.
Note that:
Note that if `name`, `author` or `version` fields aren't set they will be loaded from the NRO, thus it would show the RetroArch core's name, etc., same with the icon.
- The type needs to be **always 2** (1 = installed title, other values are invalid), and that `type` and `nro_path` **must be always present**. The other parameters are all optional.
- If `name`, `author` or `version` fields aren't set they will be loaded from the NRO, thus it would show the RetroArch core's name, etc., same with the icon.
- The argv string must not include the NRO path. Usual homebrew behaviour would be `<nro-path> <arg-1> <arg-2> <...>`, but uLaunch itself appends the NRO path before the specified argv when launching the menu entry, so you should just provide `<arg-1> <arg-2> <...>`
## Translations
uLaunch is in English by default. However, you can make translations by editing the [LangDefault.json](https://github.com/XorTroll/uLaunch/blob/master/LibraryAppletQMenu/RomFs/LangDefault.json) translation file's strings and placing it into `sd:/ulaunch/langs` named as the language's code ("en-US" for American English, "es" for Spanish, "fr" for French... proper list [here](https://switchbrew.org/wiki/Settings_services#LanguageCode) - example: `sd:/ulaunch/lang/es.json` for custom strings when the console's language is Spanish)
uLaunch is in English by default. However, you can make translations by editing the [LangDefault.json](https://github.com/XorTroll/uLaunch/blob/master/LibraryAppletQMenu/RomFs/LangDefault.json) translation file's strings and placing it into `sd:/ulaunch/langs` named as the language's code ("en-US" for American English, "es" for Spanish, "fr" for French... proper list [here](https://switchbrew.org/wiki/Settings_services#LanguageCode)
Example: `sd:/ulaunch/lang/es.json` for custom strings (which would be displayed if the console's language is Spanish)
## Installing and removing
@ -163,7 +214,7 @@ Check if folders `0100000000001000`, `010000000000100B`, `0100000000001001` and
1 - Delete the following folders: `010000000000100B`, `0100000000001001` and `01008BB00013C000`.
2 - Delete **only `exefs.nsp` file** from `0100000000001000` directory (if there is a `romfs` folder present it could be a normal HOME menu theme)
2 - Delete **only the `exefs.nsp` file** from `0100000000001000` directory (if there is a `romfs` folder present it could be a normal HOME menu theme)
## Compiling
@ -171,12 +222,16 @@ You will need devkitPro, devkitA64, libnx and all SDL2 libraries for switch deve
Clone (**recursively!**) this repo (uses libstratosphere and Plutonium submodules) and hit `make` in root. It should build everything and generate a `titles` folder ready for use inside `SdOut`.
Using `make dev` instead of regular `make` will compile uLaunch in debug mode, which makes the backend process display a debug console and a special menu before usual boot to perform special tasks. This is only meant to be used by developers.
## Errors
If you get a crash using uLaunch, please check:
- If the crash's title is `0100000000001000`, `010000000000100B`, `0100000000001001` or `01008BB00013C000` and **you know for sure you have this project in your SD**, then it is very likely related to this project.
- Note that `0100000000001001` and `01008BB00013C000` are the IDs of the processes used by uLaunch to target homebrew, so if you get a crash from these using uLaunch it probably means a crash from the homebrew you were using.
## Credits
- Several scene developers for help with small issues or features.
@ -187,4 +242,6 @@ If you get a crash using uLaunch, please check:
- C4Phoenix for the amazing design of this project's logo.
- [Icons8](https://icons8.com/) website for a big part of the icons used by the default style.
- [Icons8](https://icons8.com/) website for a big part of the icons used by the default style.
- Everyone from Discord or other places whose suggestions made this project a little bit better :)

8
TODO.md
View file

@ -1,13 +1,11 @@
# uLaunch's TODO list
## Plans
This could be also considered as TODOs, but not really needed for a first release:
- Improve QDaemons's IPC with two services, one only for QMenu and the other one for any process to interact with uLaunch:
- Easy way to detect whether uLaunch is present
- Get whether a title/homebrew is opened
- RE controller applet, allow managing controllers same way normal qlaunch does
- Get album working (for some reason album applet won't work...?)