libKonogonka/README.md

<img src="misc/logo.svg" title="" alt="libKonogonka" data-align="center">

![License](https://img.shields.io/badge/License-GPLv3-blue.svg) [![status-badge](https://ci.redrise.ru/api/badges/11/status.svg)](https://ci.redrise.ru/repos/11)

Library made to work with NS-specific files / filesystem images. Separated backend of [konogonka](https://github.com/developersu/konogonka) ([independent source location](https://git.redrise.ru/desu/konogonka))

### Let's stay in touch

You can get this application from independent source location: [https://git.redrise.ru/desu/libKonogonka](https://git.redrise.ru/desu/libKonogonka)

### License

[GNU General Public License v3 or higher](https://git.redrise.ru/desu/libKonogonka/LICENSE)

### Used libraries & resources

* [Bouncy Castle](https://www.bouncycastle.org/) for Java.
* [Java-XTS-AES](https://github.com/horrorho/Java-XTS-AES) by horrorho with minimal changes.
* [lz4-java](https://github.com/lz4/lz4-java) 

#### Thanks

* [Switch brew](https://switchbrew.org) wiki
* Original [ScriesM software](https://github.com/SciresM/)
* roothorick, [shchmue](https://github.com/shchmue/), He, other Team AtlasNX discord members for their advices, notes and examples!

### System requirements

JRE/JDK 8u60 or higher.

### Build

See .drone.yml

### Install on local host (local maven repo)

`# mvn install`
1. Start moving to 'InFileStreamProducer' entity to simplify work with [inside-NCA]-[in-pfs0/romfs]-[sub-files] that could be located inside encrypted or not encrypted sections. This approach will allow us to map filesystem to/as 'enough-informed' objects that could perform actions on content without pre-extraction. For example decompress NSO0 'ELF' sections from the inside PFS0 that is located inside NCA3 that is located inside XCI/NSP. 2. Add NSO0 support. Add NSO0 decompressor/extractor 3. Add logo draft sketch, update dependencies, add LZ4 libs deps, add final identifier in some places 2022-12-09 05:37:31 +03:00			`<img src="misc/logo.svg" title="" alt="libKonogonka" data-align="center">`
Init 2022-08-10 15:55:50 +03:00
Move to Woodpecker CI 2024-11-21 01:28:59 +03:00			`![License](https://img.shields.io/badge/License-GPLv3-blue.svg) [![status-badge](https://ci.redrise.ru/api/badges/11/status.svg)](https://ci.redrise.ru/repos/11)`
Init 2022-08-10 15:55:50 +03:00
Rework NSO0 related classes. Added option to pick one of the ELF's sections (.text, .data or .rodata) unpacked without pre-dumping it on disk. Clean 'System.out.print*' 2022-12-10 00:26:21 +03:00			`Library made to work with NS-specific files / filesystem images. Separated backend of [konogonka](https://github.com/developersu/konogonka) ([independent source location](https://git.redrise.ru/desu/konogonka))`
Small fixes, minor updates. 2022-12-07 04:22:23 +03:00
			`### Let's stay in touch`

			`You can get this application from independent source location: [https://git.redrise.ru/desu/libKonogonka](https://git.redrise.ru/desu/libKonogonka)`
Init 2022-08-10 15:55:50 +03:00
			`### License`

Misc fixes, start rewriting RomFS parts to make it in line with AesCtrBufferedInputStream 2022-09-19 23:04:59 +03:00			`[GNU General Public License v3 or higher](https://git.redrise.ru/desu/libKonogonka/LICENSE)`
Init 2022-08-10 15:55:50 +03:00
			`### Used libraries & resources`
1. Start moving to 'InFileStreamProducer' entity to simplify work with [inside-NCA]-[in-pfs0/romfs]-[sub-files] that could be located inside encrypted or not encrypted sections. This approach will allow us to map filesystem to/as 'enough-informed' objects that could perform actions on content without pre-extraction. For example decompress NSO0 'ELF' sections from the inside PFS0 that is located inside NCA3 that is located inside XCI/NSP. 2. Add NSO0 support. Add NSO0 decompressor/extractor 3. Add logo draft sketch, update dependencies, add LZ4 libs deps, add final identifier in some places 2022-12-09 05:37:31 +03:00
Init 2022-08-10 15:55:50 +03:00			`* [Bouncy Castle](https://www.bouncycastle.org/) for Java.`
			`* [Java-XTS-AES](https://github.com/horrorho/Java-XTS-AES) by horrorho with minimal changes.`
1. Start moving to 'InFileStreamProducer' entity to simplify work with [inside-NCA]-[in-pfs0/romfs]-[sub-files] that could be located inside encrypted or not encrypted sections. This approach will allow us to map filesystem to/as 'enough-informed' objects that could perform actions on content without pre-extraction. For example decompress NSO0 'ELF' sections from the inside PFS0 that is located inside NCA3 that is located inside XCI/NSP. 2. Add NSO0 support. Add NSO0 decompressor/extractor 3. Add logo draft sketch, update dependencies, add LZ4 libs deps, add final identifier in some places 2022-12-09 05:37:31 +03:00			`* [lz4-java](https://github.com/lz4/lz4-java)`

			`#### Thanks`
Init 2022-08-10 15:55:50 +03:00
Rework NSO0 related classes. Added option to pick one of the ELF's sections (.text, .data or .rodata) unpacked without pre-dumping it on disk. Clean 'System.out.print*' 2022-12-10 00:26:21 +03:00			`* [Switch brew](https://switchbrew.org) wiki`
			`* Original [ScriesM software](https://github.com/SciresM/)`
Init 2022-08-10 15:55:50 +03:00			`* roothorick, [shchmue](https://github.com/shchmue/), He, other Team AtlasNX discord members for their advices, notes and examples!`

			`### System requirements`

			`JRE/JDK 8u60 or higher.`

			`### Build`

Rework NSO0 related classes. Added option to pick one of the ELF's sections (.text, .data or .rodata) unpacked without pre-dumping it on disk. Clean 'System.out.print*' 2022-12-10 00:26:21 +03:00			`See .drone.yml`

			`### Install on local host (local maven repo)`

Update Ini1Provider, make reliable package2 tests 2023-01-16 21:01:51 +03:00			`# mvn install`