JKSV

# JKSV Rewrite

---

If you appreciate my work, or if JKSM or JKSV has gotten you out of a jam, please consider supporting development through a donation. Any contribution is appreciated, but never required! Creating and maintaining these tools takes a lot of time and effort.

## Rewritten from the ground up: JKSV's rewrite makes improvements on the following: - **Clean up and modernize the codebase:** The original master branch code became a mess over time and is extremely difficult to navigate and maintain. - **Fully encapsulated design:** Everything is encapsulated via interfaces. This alone makes the rewrite easier to work with and **much** less fragile in comparison to the original. - **Improved error logging:** The master branch did an extremely poor job at logging errors. The rewrite corrects this greatly. Each error is logged with the file, line, and column making errors and bugs easier to track down. - **Designed with translations in mind:** Unlike the original, translations weren't a feature that were tacked on later. This also made the original difficult to maintain. - **Use standard formats:** JKSV originally used a custom file parser for data files. This has been removed in favor of JSON using libjson-c. - **Uses [FsLib](https://github.com/J-D-K/FsLib):** - All file operations are handled using FsLib. FsLib is a C++ wrapper I wrote around libnx's FS API. - FsLib also handles SD card redirection so libraries that depend on C standard I/O can read and write files to and from the SD card. - **Streamlined Google Drive login.** - **Improve WebDav Support and code.** - **Title Cache:** Titles found on the system are cached the same way [JKSM](https://github.com/J-D-K/JKSM) was. This improves boot time greatly on higher Switch firmware versions. - The title cache is also **auto-invalidating**. No need to manually update it like JKSM on 3DS. - **Modern C++ design patterns and resource management:** - **Polymorphism and state patterns** instead of scattered global variables and logic. - **Smart pointers** to enure no memory leaks can occur. - **C APIs wrapped in smart pointers and classes** to ensure proper cleanup. - **Thread-pooled task system** Reduces overhead by reusing threads for tasks rather than creating and destroying them repeatedly. - **SDL textures** are all wrapped and managed by a central texture manager. JKSV's rewrite is a ground-up rewrite. It shares none of the original's code **at all**. **Everything** has been reworked and rewritten. ## Features: - **Supports all save data types used on Nintendo Switch:** - **Account** (User) - **System** - **BCAT** - **Device / Shared** - **Temporary** - **Cache** - **System BCAT** - **Export Options:** - Standard, unpacked folders for editors. - ZIP for better compatibility. * **NOTE: ZIP is required and enforced for cloud backup!** - **All At Once:** - JKSV can backup all the save data on the system or for individual users at once. - **Cloud Support:** - If configured, JKSV currently supports: - **Google Drive** - **WebDav** - JKSV can be configured to upload these automatically. - **Create Save Data:** - JKSV can create save data for any title on your system by **itself**. No need to start a game to import data for it. - JKSV can create save data for every title found on your system **at once** for a single user. - **SVI File Support:** - Import and create save data for titles not installed on your system. - **NOTE: These are not properly installed to the system. Use at your own discretion!** - **Resize save data:** - JKSV can extend save data to any size you would like. This is useful for games such as Minecraft. - **Cleanup Tools** - JKSV features functions and tools to make cleanup less of a chore compared to Nintendo's Data Management and confirmation prompts: - Just hold A for three seconds to: - Delete save data for individual games. - Delete all save data for a single user at once. - **Statistics:** - View basic data and statistics about the save and title. - **Customizable:** - JKSV features many options to customize it to your liking. - **Safety:** - JKSV can require holding to complete destructive operations or be set to make quick automatic backups upon restoring backups. ## Remote Storage / Upload instructions. Detailed instructions for how to use JKSV's Google Drive and WebDav features can be found **[here](https://switch.hacks.guide/homebrew/jksv.html)**. ## Building: 1. Requires [devkitPro](https://devkitpro.org/), [libnx](https://github.com/switchbrew/libnx), and Python. 2. Select Switch Development when installing or follow the instructions [here](https://devkitpro.org/wiki/Getting_Started) if you're not running Windows. 3. Install the following libraries using pacman and/or devkitpro's MSYS2 installation: - **switch-bzip2** - **switch-curl** - **switch-freetype** - **switch-harfbuzz** - **switch-libjpeg-turbo** - **switch-libjson-c** - **switch-libpng** - **switch-libwebp** - **switch-sdl2** - **switch-sdl2_image** - **switch-tinyxml2** - **switch-zlib** 4. Clone JKSV's directory using the command `git clone --recurse-submodules https://github.com/J-D-K/JKSV.git` so you clone the libraries I've built for JKSV included. 5. Press Y while in the Switch Homebrew menu, navigate to the directory JKSV was cloned into on your PC, and type `make -j send`. JKSV should build and nxlink will attempt to send it to your Switch. ## Credits and Thanks: * [Iguniisu](https://github.com/igniscitrinus) for the icon. * Uses graphics from [Twemoji](https://github.com/twitter/twemoji) covered by the [Creative Commons License](https://creativecommons.org/licenses/by/4.0/legalcode) * [shared-font](https://github.com/switchbrew/switch-portlibs-examples) example by yellows8 for loading system font with Freetype. * Everyone that has contributed to translating and fixing the translations for JKSV.