Open Shop Channel Downloader
| This is an old revision of this page, as edited by Dhtdht020 (talk | contribs) at 16:33, 12 June 2020. It may differ significantly from the current revision. |
| Open Shop Channel Downloader | |
 | |
| General | |
|---|---|
| Author(s) | dhtdht020 |
| Type | PC utility |
| Version | v1.2.5 |
| Links | |
| Download | |
| Website | |
| Discussion | |
| Source | |
Open Shop Channel Downloader, or OSC-DL, is a command line / desktop program made to allow easy access to the Open Shop Channel application repository. With this tool, you can view, download and extract homebrew application present on a given repository.
Using the GUI
After downloading the GUI build for your operating system (or running the file xosc_dl.py in python3), you should see the full list of homebrew applications currently on the Open Shop Channel repository.
On the right side of the program, the metadata and information for the currently selected app is displayed, including the long description and the download button.
The following metadata is displayed:
- App Name: Display Name of the app, as specified in it's meta.xml file.
- Short Description: Short description, either grabbed from the app's meta.xml file or overwritten by the metadata.json on the server.
- Long Description: Long description, either grabbed from the app's meta.xml file or overwritten by the metadata.json on the server.
- Version: Version of the app, as specified in it's meta.xml file.
- Developer: Author of the app, as specified in it's meta.xml file.
- Contributors: Contributors listed in it's meta.xml file.
- Release Date: Release date of the app, as specified in it's meta.xml file.
You can also edit the output file name, or have osc-dl extract it right after download.
To start downloading the app, press the Download button. The program will freeze for a few moment while it's grabbing the app.
Using the CLI
Downloading Homebrew (get command)
You can download homebrew from the Open Shop Channel by using osc-dl get
Example usage: osc-dl get -n wiixplorer
The following arguments can be used
- -n / --name Required. Name of homebrew app to download
- -c / --noconfirm Disable download confirmation message after application metadata displays.
- -o / --output Output file name.
Homebrew Metadata (meta command)
You can obtain visual metadata or metadata items about homebrew applications in the Open Shop Channel by using osc-dl meta
Example usage: osc-dl meta -n wiixplorer
Another example usage: osc-dl meta -n wiixplorer -t version
The following arguments can be used
- -n / --name Required. Name of homebrew app to obtain metadata for.
- -t / --type Type of metadata to obtain (display_name, developer, version, short_description, long_description, release_date, contributors)
- -o / --output Output file name.
List Homebrew (list command)
You can list the names of all homebrew on the Open Shop Channel repository by using osc-dl list
Example usage: osc-dl list
Currently, there are no arguments, although a way to filter the results or save to a file is planned.
Querying Homebrew (query command)
You can search homebrew available on the Open Shop Channel by using osc-dl query
Example usage: osc-dl query -n wiixplorer
This command is unfinished, and can currently only check for exact matches.
The following arguments can be used
- -n / --name Required. Name of homebrew app to query.
- -v / --verify Caused query to return "True" if the app is present and "False" if it isn't.
Download Everything (get-all command)
This command was intended for debugging, and we don't recommend using it, as it might have an unexpected behaviour.
Example usage: osc-dl get-all
This command is not maintained nor supported, and although specified in help, setting output directory is not possible at the time.
Credits
NUSD was written by dhtdht020, along with all GitHub contributors who helped make it what it is.
Update History
v1.0 - April 27th, 2020
Initial release
The following features are implemented:
- Listing all apps on the remote repository.
- Obtaining and parsing metadata.
- Downloading individual apps or the entire repository.
This build does not have a GUI release!
v1.1.0 (Get & Extract) - April 27th, 2020
Added an extract argument to get and get-all! Extracts downloaded homebrew to the ExtractedApps directory when used.
Example Usage:
- osc-dl get -n wiixplorer -e
- osc-dl get -n wiixplorer -e -c
- osc-dl get --name wiixplorer --extract --noconfirm
- osc-dl get-all -e
v1.2.0 (Hosts & Secondary Repositories) - May 28th, 2020
New Features:
- (Initial Implementation) Added a command to view the raw Secondary Repository List on the server.
- Added --host (-r) argument to query, get, get-all, get-list, and meta commands. This can be used to obtain data from a server that isn't hbb1.oscwii.org.
v1.2.5 (Color Scheme & GUI) - June 5, 2020
Visual Enhancements:
- Some output is now colored!
- Terminal spinner now displays when the program is busy.
New Features:
- Added --host (-r) argument to "list" command
- Added --raw to "list" command: Prints list without the terminal spinner.
- Added option to get dictionary for metadata.
- Added a GUI! Get osc-dl_gui.exe below for the GUI version!
Technical Changes:
- Running OSC-DL with no arguments now displays a nice ASCII art.
- Separated metadata from download script.
Fixes:
- Metadata types no longer return None