From ee819a22ce3cf314e8e1cef44c9c41687c0c7f94 Mon Sep 17 00:00:00 2001 From: ppkantorski <6467366+ppkantorski@users.noreply.github.com> Date: Fri, 29 Aug 2025 02:40:24 -0700 Subject: [PATCH] Update README.md --- README.md | 58 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 36 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 600315a..f837233 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,55 @@ # Alchemist (Ultrahand v2.1.0+) -An Ultrahand package designed for managing and converting mods on the Nintendo Switch. +An Ultrahand package for managing, converting, and installing mods on the Nintendo Switch. ![banner](.pics/banner.png) +## Overview + +Alchemist is a comprehensive mod management package designed to streamline mod organization, conversion, and deployment. It supports exeFS patches, content mods, pchtxt conversion to IPS or cheat formats, and integrates utilities for maintaining a clean SD card environment. Mod repositories are managed dynamically, ensuring users can download, update, and install mods efficiently. + ## Configuration -The `package.ini` file contains the following configurations: +All options are accessible through `package.ini` and its included forwarders. -### Mod Management -- `[*Toggle exeFS Patches]`: Toggles exeFS patches by selection. -- `[*Delete exeFS Patches]`: Deletes selected exeFS patches. -- `[*Toggle Content Mods]`: Toggles content modifications by selection. -- `[*Delete Content Mods]`: Deletes selected content modifications. -- `[*Search Pattern]`: Configure search patterns for mod groups. -- `[Enable All]`: Enables all mods based on search patterns. -- `[Disable All]`: Disables all mods based on search patterns. +### Core Features -### Mod Conversion -- `[*pchtxt -> ips]`: Converts pchtxt files to IPS patches. -- `[*pchtxt -> cheat]`: Converts pchtxt files to cheat codes. +#### Title ID +- Dynamically tracks the current game using `Title ID`. +- Automatically updates mod selection and installation paths based on the active title. -Each configuration has a set of commands that perform the corresponding actions. The commands include moving, deleting, creating directories, copying files, and converting files to specific formats. +#### Mod Management +- `[*exeFS Patches]` and `[*Contents Mods]`: Forwarded sections to toggle, enable, or delete patches or content mods. +- Search patterns can filter mods for bulk operations. +- `Enable All` / `Disable All` options apply actions across filtered mods. + +#### Mod Conversion +- `[*pchtxt -> ips]`: Converts `.pchtxt` files to IPS patches, creating the required folder structure automatically. +- `[*pchtxt -> cheat]`: Converts `.pchtxt` files into cheat code format. +- `[*Delete pchtxt]`: Cleans up `.pchtxt` files after conversion or installation. + +#### Mod Installation +- `[*Install pchtxt]` and `[*Install Contents]`: Forwarded sections that install mods from the configured repositories. +- Supports installation by title ID or search pattern. + +#### Miscellaneous Tools +- `Dot Clean` removes macOS metadata files (`._*`) from `/atmosphere/`, `/switch/`, `/config/`, or the entire SD card. +- `Software Update` integrates automatic updating of the Alchemist package and all associated mod repositories, with version information stored in `config.ini`. ## Obtaining Mods -To use the mods provided in the Alchemist package, you will need to obtain them separately. The mods should be placed in the appropriate folders within the `Alchemist` directory. +Alchemist does not include mods directly. Mods are distributed through the Alchemist repositories: -Please refer to the shared documentation or additional resources to acquire the specific mods you are interested in. Once you have obtained the mods, place them in the corresponding folders within the `Alchemist` directory. +- **Pchtxt Mods**: Available in [Alchemist Repos](https://github.com/ppkantorski/Alchemist-Repos). Users can download individual author packs or use the “Update All” feature within Alchemist. +- **Content Mods**: Organized by title ID in the same repositories. Use the “Install Contents” section to deploy content mods to the correct directories. + +Mods must be placed in the corresponding `repos/pchtxts/` or `repos/contents/` subfolders for Alchemist to process them correctly. ## Installation -To install `Alchemist`: - -1. Unzip `Alchemist.zip` to the root of your SD card. The `Alchemist` directory will exist within `/switch/.packages/`. - -Note: Make sure you have organized the mods properly within the subdirectories as mentioned in the "Obtaining Mods" section. +1. Unzip `Alchemist.zip` to the root of your SD card. The `Alchemist` folder will appear under `/switch/.packages/`. +2. Ensure that mods are organized in the `repos` subfolders as outlined above. +3. Use the package menus to manage, convert, or install mods as needed. ## Additional Information -For more details on the Ultrahand Overlay project and its features, please refer to the [official GitHub repository](https://github.com/ppkantorski/Ultrahand-Overlay). +For detailed instructions, feature documentation, and support, see the [Ultrahand Overlay GitHub repository](https://github.com/ppkantorski/Ultrahand-Overlay).