Ultrahand Overlay Switch: Difference between revisions

Ultrahand Overlay
Ultrahand Overlay
General
Author	ppkantorski
Type	Overlays
Version	1.0.7
License	MIT License
Last Updated	2023/06/02
Links
	Download
	Website
	Source

Revision as of 13:05, 5 Haziran 2023

Ultrahand Overlay is a C++ program designed to provide a user-friendly main menu overlay for performing various file operations on different platforms, including the Nintendo Switch.

Inspired by the new Zelda feature, Ultrahand lets you unleash your creativity and shape your digital experiences like never before. It uses the Tesla library to create an interactive menu interface and allows you to perform actions such as creating directories, copying files, renaming files, moving directories, deleting files, and parsing INI files.

Note: Running homebrew software on your Nintendo Switch may void your warranty and carry certain risks. Ensure that you understand the implications and follow the appropriate guidelines and precautions when using homebrew software.

Features

Create Directories - Simply specify the directory path, and Ultrahand will create directories for you.
Copy Files or Directories - Just provide the source file or directory path and the destination file or directory path, and Ultrahand will handle the copying process seamlessly.
Delete Files or Directories - By specifying the file or directory path, Ultrahand will promptly remove it for you, making the deletion process hassle-free.
Move Files or Directories -Provide the source file or directory path and the destination directory path, and Ultrahand will take care of moving them, ensuring their seamless relocation.
Modify INI Files - You can update existing key-value pairs, add new entries, or even create new sections within the INI file. Ultrahand makes it easy to customize and tailor the configurations of your INI files.
Provide a convenient command-line interface to perform various file management functions.

Installation

In order to run the Ultrahand File Management System on the Nintendo Switch, you need to have the necessary homebrew environment set up on your console.

How to setup:

Place the .ovl file into the /switch/.overlays/ directory on your Switch's SD card.
Make sure you have nx-ovlloader and Tesla Menu installed.
Create a directory named ultrahand in the config folder on your SD card.
Place the config.ini file in the ultrahand directory (or sub-directory). This file contains the configuration options for Ultrahand.
Your commands will show up on the Tesla Menu (L+D-Pad Down+Right Stick Button) within the Ultrahand overlay.

User guide

Configuration options

The config.ini file contains multiple sections, each defining a set of commands that can be executed. The sections are enclosed in square brackets [ ], and the commands are listed below each section.

Here's an example of the config.ini file:

[make directories]
mkdir /config/ultrahand/example1/
mkdir /config/ultrahand/example2/

[copy files]
copy /config/ultrahand/config.ini /config/ultrahand/example1/
copy /config/ultrahand/config.ini /config/ultrahand/example2/

[rename files]
move /config/ultrahand/example1/config.ini /config/ultrahand/example1/configX.ini
move /config/ultrahand/example2/config.ini /config/ultrahand/example2/configX.ini

[move directories]
move /config/ultrahand/example1/ /config/ultrahand/example3/
move /config/ultrahand/example2/ /config/ultrahand/example4/

[delete files]
delete /config/ultrahand/example1/config.ini
delete /config/ultrahand/example2/config.ini

[delete directories]
delete /config/ultrahand/example1/
delete /config/ultrahand/example2/
delete /config/ultrahand/example3/
delete /config/ultrahand/example4/

[modify ini file]
copy /bootloader/hekate_ipl.ini /config/ultrahand/
set-ini-val /config/ultrahand/hekate_ipl.ini 'Atmosphere' fss0 gonnawritesomethingelse
new-ini-entry /config/ultrahand/hekate_ipl.ini 'Atmosphere' booty true

You can add your own sections and commands to customize the actions performed by Ultrahand.

Note: The paths specified in the commands should be relative to the SD card root directory and should start with /.

Command reference

Ultrahand supports the following commands:

mkdir <directory_path>: make or mkdir: Creates a directory.
copy <source_file_path> <destination_file_path>: copy or cp: Copies a file or diectory.
delete <file_path>: delete or del: Deletes a file or directory.
move <file_path> <destination_directory_path>: move or mv: Moves/renames a file/directory to a new location/label.
set-ini-val <file_to_edit> <desired_section> <desired_key> <desired_value>: set-ini-val or set-ini-value: Edits an INI file by updating a section with a desired key-value pair.
set-ini-key <file_to_edit> <desired_section> <desired_key> <desired_new_key>: set-ini-key: Edits an INI file by updating a section with a new key.
new-ini-entry <file_to_edit> <desired_section> <desired_key> <desired_value>: new-ini-entry: Edits an INI file by adding a new entry to a section.

Make sure to follow the correct syntax and provide the required arguments for each command.

You can configure these commands in the config.ini file by specifying them under the corresponding options. Be sure to provide the necessary arguments as described for each command.

Controls

A - Execute any command

X - View the individual command lines written in the ini for execution

Compatibility

HOS 16.0.0+.

Changelog

v1.0.7

Improvements to menu. Version handling for user packages.

v1.6

More improvements, "edit-ini" commands have now been labeled "set-ini". You can also press X on an individual command and see and execute individual lines within.
- Update: Faster copying. - 05/31/23 4:19PM PST
- Update: Even faster copying. - 05/31/23 4:35PM PST
- Update: Slight size reduction. - 06/01/23 6:34PM PST

v1.0.5

Too many bug fixes with statement logic.
Ability to execute individual commands from a package have been added (press X on package).
More slight tweaks and capabilities packed into the functions.
- Update: Fixed editINI adding new lines by mistake. - 05/29/23 05:16 PM PST
- Update: Fixed copy directory not copying subdirectories. - 05/29/23 05:59 PM PST
- Update: Edit ini key or value now. - 05/29/23 09:40 PM PST

v1.0.4

Slight tweaks to libtesla. This is pre-release, but it is still commits ahead of 1.0.3 and stable.
- Update: Got new features as well as pattern searching implemented. New documentation coming soon. 05/29/23 9:11 AM PST

v1.0.3

Improvements to code structure, menu layout, new commands (reset, shutdown), etc.
- Update: Copy function now can rename to file as well as copy to directory. This makes it simulate "cp" a bit better. - 05/27/23 7:37 AM PST
- Update: Fixed edit-ini bugs. - 05/27/23 2:21 PM PST
- Update: Fixed even more edit-ini bugs. Should be working. - 05/27/23 3:27 PM PST
- Update: Fixed one last edit-ini bug for handling command. Testing safer reboot method. - 05/27/23 9:40 PM PST

v1.0.2

Folders have now been added.
Future plans: cleaner UI, separation for "Packages" and "Commands" sections with titles.
- Update: Fixed a bug that occurred with linking folders. - 05/28/23 05:59 PM

v1.0.1

New feature 'parse-ini'.
Update: Delete directory bug fix. - 05/28/23 8:11 AM PST

v1.0

First Release.
- Update: Improved structure and examples for testing. - 05/25/23 5:52 PM PST

External links

@@ Line 1: / Line 1: @@
 {{Infobox Switch Homebrews
 |title=Ultrahand Overlay
-|image=ultrahandoverlayswitch.png
+|image=ultrahandoverlaynx.png
 |description=The fully craft-able overlay executor.
 |author=ppkantorski
@@ Line 8: / Line 8: @@
 |version=1.0.7
 |license=MIT
-|download=https://dlhb.gamebrew.org/switchhomebrews/ultrahandoverlayswitch.7z
+|download=https://dlhb.gamebrew.org/switchhomebrews/ultrahandoverlaynx.7z
 |website=https://gbatemp.net/threads/ultrahand-overlay-the-fully-craft-able-overlay-executor.633560/
 |source=https://github.com/ppkantorski/Ultrahand-Overlay
 |donation=
 }}
-{{#seo:
+Ultrahand Overlay is a C++ program designed to provide a user-friendly main menu overlay for performing various file operations on different platforms, including the Nintendo Switch.
-|title=Switch Homebrew Plugins (Overlays) - GameBrew
-|title_mode=append
-|image=ultrahandoverlayswitch.png
-|image_alt=Ultrahand Overlay
-}}
-Ultrahand Overlay is a C++ program designed to provide a user-friendly main menu overlay for performing various file operations on different platforms, including the Nintendo Switch. It uses the TESLA library to create an interactive menu interface and allows you to perform actions such as creating directories, copying files, renaming files, moving directories, deleting files, and parsing INI files.
-==Features==
+Inspired by the new Zelda feature, Ultrahand lets you unleash your creativity and shape your digital experiences like never before. It uses the Tesla library to create an interactive menu interface and allows you to perform actions such as creating directories, copying files, renaming files, moving directories, deleting files, and parsing INI files.
-Ultrahand is a command-line tool that provides functionality for managing files and directories on an SD card. It offers the following features:
-* '''Create directories:''' You can use Ultrahand to create directories on your SD card. Simply specify the directory path, and Ultrahand will create it for you.
-* '''Copy files:''' Ultrahand allows you to copy files from one location to another on your SD card. Just provide the source file path and the destination file path, and Ultrahand will handle the file copying process.
-* '''Delete files:''' With Ultrahand, you can easily delete files from your SD card. Just specify the file path, and Ultrahand will remove the file for you.
-* '''Move files:''' Ultrahand enables you to move files from one directory to another on your SD card. Provide the file path and the destination directory path, and Ultrahand will handle the file movement for you.
-==Nintendo Switch Compatibility==
+'''Note:''' Running homebrew software on your Nintendo Switch may void your warranty and carry certain risks. Ensure that you understand the implications and follow the appropriate guidelines and precautions when using homebrew software.
-It is compatible with the Nintendo Switch, allowing users to manage files and perform file operations directly on their Switch console. To run the Ultrahand File Management System on the Nintendo Switch, you need to have the necessary homebrew environment set up on your console. Once you have the homebrew environment set up, you can transfer the compiled executable file to your Switch and launch it using the Tesla Overlay.
-Please note that running homebrew software on your Nintendo Switch may void your warranty and carry certain risks.
+==Features==
+*Create Directories - Simply specify the directory path, and Ultrahand will create directories for you.
+*Copy Files or Directories - Just provide the source file or directory path and the destination file or directory path, and Ultrahand will handle the copying process seamlessly.
+*Delete Files or Directories - By specifying the file or directory path, Ultrahand will promptly remove it for you, making the deletion process hassle-free.
+*Move Files or Directories -Provide the source file or directory path and the destination directory path, and Ultrahand will take care of moving them, ensuring their seamless relocation.
+*Modify INI Files - You can update existing key-value pairs, add new entries, or even create new sections within the INI file. Ultrahand makes it easy to customize and tailor the configurations of your INI files.
+*Provide a convenient command-line interface to perform various file management functions.
-== Getting Started ==
+==Installation==
-=== Compilation Prerequisites ===
+In order to run the Ultrahand File Management System on the Nintendo Switch, you need to have the necessary homebrew environment set up on your console.
-To compile and run the program, you need to have the following dependencies installed:
-* TESLA library
+How to setup:
-* Standard C++ libraries
+*Place the .ovl file into the /switch/.overlays/ directory on your Switch's SD card.
+*Make sure you have [[NX-ovlloader Switch|nx-ovlloader]] and [[Tesla Menu Switch|Tesla Menu]] installed.
+*Create a directory named ultrahand in the config folder on your SD card.
+*Place the config.ini file in the ultrahand directory (or sub-directory). This file contains the [[#Configuration options|configuration options]] for Ultrahand.
+*Your commands will show up on the Tesla Menu (L+D-Pad Down+Right Stick Button) within the Ultrahand overlay.
-=== Usage ===
+==User guide==
-To use Ultrahand, follow these steps:
+=== Configuration options ===
-# Create a directory named ultrahand in the config folder on your SD card.
-# Place the config.ini file in the ultrahand directory. This file contains the configuration options for Ultrahand.
-# Launch Ultrahand by executing the compiled binary.
-==Configuration Options ==
 The config.ini file contains multiple sections, each defining a set of commands that can be executed. The sections are enclosed in square brackets [ ], and the commands are listed below each section.
 Here's an example of the config.ini file:
-<pre>[make directories]
+<pre>
+[make directories]
 mkdir /config/ultrahand/example1/
 mkdir /config/ultrahand/example2/
@@ Line 86: / Line 78: @@
 You can add your own sections and commands to customize the actions performed by Ultrahand.
-Note: The paths specified in the commands should be relative to the SD card root directory and should start with /.
+'''Note:''' The paths specified in the commands should be relative to the SD card root directory and should start with /.
-== Command Reference ==
+=== Command reference ===
 Ultrahand supports the following commands:
-* make or mkdir: Creates a directory.
+*<code>mkdir &lt;directory_path&gt;</code>: make or mkdir: Creates a directory.
-** Usage: <code>mkdir &lt;directory_path&gt;</code>
+*<code>copy &lt;source_file_path&gt; &lt;destination_file_path&gt;</code>: copy or cp: Copies a file or diectory.
-* copy or cp: Copies a file or diectory.
+*<code>delete &lt;file_path&gt;</code>: delete or del: Deletes a file or directory.
-** Usage: <code>copy &lt;source_file_path&gt; &lt;destination_file_path&gt;</code>
+*<code>move &lt;file_path&gt; &lt;destination_directory_path&gt;</code>: move or mv: Moves/renames a file/directory to a new location/label.
-* delete or del: Deletes a file or directory.
+*<code>set-ini-val &lt;file_to_edit&gt; &lt;desired_section&gt; &lt;desired_key&gt; &lt;desired_value&gt;</code>: set-ini-val or set-ini-value: Edits an INI file by updating a section with a desired key-value pair.
-** Usage: <code>delete &lt;file_path&gt;</code>
+*<code>set-ini-key &lt;file_to_edit&gt; &lt;desired_section&gt; &lt;desired_key&gt; &lt;desired_new_key&gt;</code>: set-ini-key: Edits an INI file by updating a section with a new key.
-* move or mv: Moves/renames a file/directory to a new location/label.
+*<code>new-ini-entry &lt;file_to_edit&gt; &lt;desired_section&gt; &lt;desired_key&gt; &lt;desired_value&gt;</code>: new-ini-entry: Edits an INI file by adding a new entry to a section.
-** Usage: <code>move &lt;file_path&gt; &lt;destination_directory_path&gt;</code>
-* set-ini-val or set-ini-value: Edits an INI file by updating a section with a desired key-value pair.
-** Usage: <code>set-ini-val &lt;file_to_edit&gt; &lt;desired_section&gt; &lt;desired_key&gt; &lt;desired_value&gt;</code>
-* set-ini-key: Edits an INI file by updating a section with a new key.
-** Usage: <code>set-ini-key &lt;file_to_edit&gt; &lt;desired_section&gt; &lt;desired_key&gt; &lt;desired_new_key&gt;</code>
-* new-ini-entry: Edits an INI file by adding a new entry to a section.
-** Usage: <code>new-ini-entry &lt;file_to_edit&gt; &lt;desired_section&gt; &lt;desired_key&gt; &lt;desired_value&gt;</code>
 Make sure to follow the correct syntax and provide the required arguments for each command.
-You can configure these commands in the <code>config.ini</code> file by specifying them under the corresponding options. Make sure to provide the necessary arguments as described for each command.
+You can configure these commands in the <code>config.ini</code> file by specifying them under the corresponding options. Be sure to provide the necessary arguments as described for each command.
+==Controls==
+A - Execute any command
+X - View the individual command lines written in the ini for execution
+==Compatibility==
+HOS 16.0.0+.
 ==Changelog==
@@ Line 140: / Line 132: @@
 ** Update: Fixed a bug that occurred with linking folders. - 05/28/23 05:59 PM
 '''v1.0.1'''
-* new feature 'parse-ini'
+* New feature 'parse-ini'.
 * Update: Delete directory bug fix. - 05/28/23 8:11 AM PST
 '''v1.0'''
@@ Line 147: / Line 139: @@
 == External links ==
-* Gbatemp - https://gbatemp.net/threads/ultrahand-overlay-the-fully-craft-able-overlay-executor.633560/
+* GitHub - https://github.com/ppkantorski/Ultrahand-Overlay
-* Github - https://github.com/ppkantorski/Ultrahand-Overlay
+* GBAtemp - https://gbatemp.net/threads/ultrahand-overlay-the-fully-craft-able-overlay-executor.633560/