Sharpii-NetCore/Sharpii/README.txt

/------------------------------------------------------------------------------>
                                 Sharpii-NetCore 1.1.1
       <---------------------------------------------------------------->
                               An app by person66
                 libWiiSharp.dll by leathl (mod by scooby74029)                         
               .Net Core port for Unix Systems by TheShadowEevee
/------------------------------------------------------------------------------>



/----DESCRIPTION
/------------------------------>

Sharpii is a command line app that I made, which uses leathl's 
libWiiSharp.dll to perform tasks such as:
         - Pack, unpack, or edit .wad files
         - Pack, and unpack U8 archives
         - Patch IOS .wad files with various patches
         - Download files from NUS
         - Convert a .wav file to .bns, and vice versa
         - Convert an image file to a .tpl, and vice versa
         - Send a .dol or .wad to the Homebrew Channel over Wi-Fi


/----USAGE
/------------------------------>

I won't go in to detail here, but to see all the commands, just start 
up the terminal, navigate to the folder containing Sharpii, and type:

                                    ./Sharpii (Or your OS's equivalent)

OR, if you want help with a specific function use

                             ./Sharpii [function] -h (Or your OS's equivalent)

Where [function] would obviously be replaced with the function you want
help with.


/----NOTES
/------------------------------>

 NUS Downloading:
/------------------>
  When downloading single contents from NUS (using the -s argument) make
  sure you have both the path, and the file name when specifying the output.
  For example, if the output is set to '.\hello.app' then the file will be
  saved as 'hello.app' in the current directory. However, if the output is 
  set to 'hello.app' you will get an error.
	
  Also note that When Downloading single contents, it will only save the
  decrypted file.
  
  If you wish to download the latest content, use '-v latest' instead of the
  actual version number.
  
  If you have the output format set only to WAD, and your your output location
  has '.wad' at the end, or you have not specified one, then instead of being
  saved inside a folder, just the wad file will be saved.
	
 WAD Editing:
/------------------>
  When changing the type of WAD (using the -type argument) some of the types
  may not work, as they have not all been tested. Here is a list of what the
  different types are:
            - Channel: Regular channel WAD, nothing special
            - DLC: WAD for game DLC (downloaded game content)
            - GameChannel: Channels such as the Wii Fit or Mario Kart channels
            - HiddenChannels: A hidden channel, it wont show up on the Wii Menu
            - SystemChannels: Channels such as the Mii or Shopping channels
            - SystemTitles: Stuff like the System Menu and boot2 (but not IOSs)

  For more details see http://wiibrew.org/wiki/Title_database

 SendDol:
/------------------>
  When using Sharpii's SendDol function, please note that any arguments placed
  after the '-dol file' argument will be sent as dol arguments.

  Also note that for compression to actually work, 'zlib1.dll' must be placed in
  the same directory as Sharpii. This file is not included, but it can easily be
  found online. If you are sending a zip file instead of a dol, it wont be 
  compressed at all, no matter what.

  If you do not wish to enter an IP every time you use SendDol, then you can add
  the argument '-saveip' to the command. This will save the entered IP to the
  environmental variable 'SharpiiIP', and then, in the future, if you do not enter 
  an ip, Sharpii will use the one saved there instead. (Also applies to SendWad)

 SendWad:
/------------------>
  Since version 1.6, Sharpii has supported AHBPROT for installing WADs. This means
  that as long as you have HBC 1.0.7 or above, you will be able to install the WAD
  without a patched IOS. To use this feature, enter '-ahb' instead of '-ios IOS'

  If you do not wish to enter an IP every time you use SendDol, then you can add
  the argument '-saveip' to the command. This will save the entered IP to the
  environmental variable 'SharpiiIP', and then, in the future, if you do not enter 
  an ip, Sharpii will use the one saved there instead. (Also applies to SendDol)


/----Installing Sharpii
/------------------------------>

Since version 1.7, you have been able to install Sharpii. This allows you to run
Sharpii from anywhere without needing the exe in that directory. To install Sharpii,
just use the command 'Sharpii install'. This will copy Sharpii to your My Programs
directory, and create an environmental variable. To remove it, just use the command
'Sharpii uninstall' which will remove the environmental variable, then delete Sharpii
from My Programs.


/----SOURCE
/------------------------------>

The source for Sharpii is available at: https://github.com/TheShadowEevee/Sharpii-NetCore


/----CREDITS
/------------------------------>

Sharpii uses scooby74029's mod of libWiiSharp.dll by leathl, and 
it borrows some code from some of the examples included with libWiiSharp.

libWiiSharp can be found at: https://code.google.com/archive/p/libwiisharp/

.Net Core port by TheShadowEevee

SendWad uses CRAP's installer by WiiCrazy/I.R.on, with any edits that leathl
may have made when adding it to CustomizeMii (which is where I got the source
from). Since version 1.6, the AHBPROT code it uses is just mostly stolen from
WiiMod by jskyboo.


I would also like to thank XFlak and JoostinOnline for doing a bit of beta 
testing for me (and giving me many ideas). Thanks!


/----LICENSE
/------------------------------>

Sharpii is released under the terms of the GNU General Public License v3.
See "LICENSE.txt" for more information.


/----CHANGELOG
/------------------------------>
1.1.1
  - Fixes exit codes for Non-Windows platforms (Global fix)
  - Fixes a bug where Sharpii couldn't find a wad if the case of the wad's name when saved was different then the ID provided. (NUSD's -WAD option)
1.1.0
  - Added many error handling related features
    - Error Code's for easy identification of errors
    - Error Code lookup (Run: `Sharpii Errors [Error Code]`)
    - Custom exit codes for easy headless script error identification (Uses Exit codes 16001-16029)
    - Exit Code lookup (Run: `Sharpii ExitCodes [Exit Code]`)
  - Removed install/uninstall help text (Feature still exists but only works on Windows for now.)
  - Removed some help text relating to a currently unimplemented feature
1.0.1
  - Fixed a file path seperator bug.
1.0.0-Fork
  - Forked and Ported to Dot Net Core for use in Mac and Linux by TheShadowEevee
-----Sharpii-NetCore Above, original below-----
1.7.3
  - Still not dead!
  - Updated URLs for the downloaders to use GitHub instead of
    Google Code
  - WadInstaller.dll is now included in the release zip
1.7.2
  - I am not dead! Yay!
  - Fixed a bug that would prevent you from changing a wad type
  - Wad info now also displays the full, 16-character Title ID
1.7.1
  - Fixed a bug that prevented Sharpii from checking for SharpiiIP
    in the system variables
1.7
  - Sharpii can now be installed for use without the exe
  - SharpiiIP is now a system variable, not a user one.
  - Sharpii now looks for DLLs in the same directory as the exe
  - Bug fixes
1.6
  - SendWad now supports AHBPROT (use '-ahb')
  - IP can now be saved in an environmental variable (SharpiiIP)
    for both SendWad and SendDol (manually or with '-saveip')
  - Pointless easter eggs are fun!
  - Code cleanup/bug fixes
1.5
  - Added the ability to send WADs to the HBC using SendWad
  - You can now download an IOS with -ios # in NUSD
  - Downloaded IOS wads are now named like so: IOS##-64-####.wad
  - Under certain conditions, when downloading a wad with NUS,
    it will not be saved in a folder, just as the WAD (see ReadMe)
  - If missing dll's are detected (WadInstaller or libWiiSharp),
    Sharpii will ask to download them, if they are required.
  - You can now use a .dol file instead of a .wad with the '-dol'
    in the WAD editor/packer
  - Probably a few other little things I have forgotten
  - Even more code cleanup and bug fixes
1.4
  - Added the ability to send arguments in the SendDol function
  - Changed the way the SendDol function works a little
  - More code cleanup and bug fixes
1.3
  - Added the ability to copy parts of one WAD to a different
    WAD (either the banner, the icon, the sound, or the dol)
  - Added the ability to download just a single content from NUS
  - Code cleanup and bug fixes
  - Sharpii can now find JoostinOnline a girlfriend! :P
1.2
  - Added version patch support for IOS patching
  - Switched to scooby74029's mod of libWiiSharp 
  - Bug fixes
1.1
  - Added support for NUS downloading
1.0
  - Initial release