Switch-Toolbox/README.md

# Switch-Toolbox
A tool to edit many formats of Nintendo Switch and Wii U. 

## Changelog 1.0 Experimental / BETA
https://docs.google.com/spreadsheets/d/16JLhGBJL5U5hpKWspL-pzYIaRL23X1YKEmia6pbsGbc/edit#gid=1386834576

## Releases
https://github.com/KillzXGaming/Switch-Toolbox/releases

## Features

This tool currently features:
- BFRES
   - Fully supports Wii U and Switch.
   - Model importing (dae, fbx, obj, and csv)
   - Material editing (Render info, texture mapping, parameters, etc)
   - Material copying
   - Animation and model sub section can be exported/imported.
   - Can delete, add, replace individual objects from an fmdl.
   - Can create new sub sections and data
   - Can preview skeletal, SRT, param, texture pattern, and bone visual animations. (Param ones will vary)
   - Can export and import fully rigged models with bone support.
   - Can convert gif files to texture pattern animations. Very WIP atm.
   
Can Edit Formats
- BFRES
- BNTX
- NUTEXB
- XTX
- SARC
- BARS
- KCL
- BFFNT
- BFLIM
- GFPAK
- BEA
- AAMP (Wii U and Switch)
- BYAML/BYML (Wii U, 3DS, and Switch)
- PTCL (Wii U, 3DS, and Switch)
- TMPK

Can Preview
- BCRES
   - Models, materials, and textures.
- BFSHA
   - Can view options, samplers, attributes, and uniform blocks.
- BNSH
   - Can extract shader vertex and fragment shaders from variations/programs
- SHARCFB and SHARC
   - Basic preview of some shader program data.
   - Can edit both v1 and v2 AAMP (Wii U and Switch)
- EFC
   - Can preview effect tables and link PTCL.
- NUT
   - Can preview NTWU, NTP3, and NTWD variants. Editng will be soon
- MSBT
   - Very basic previewing.
- TMPK
  - Can extract files and decompress
  - Can save back. 
- MP3, OGG, IDSP, HPS, WAV, BFWAV, BFSTM, BCWAV, BCWAV
  - Can listen to audio and convert between certain formats. Thanks to VGAudio and CSCore
	

   
## Building
To build make sure you have Visual Studio installed (I use 2017, older versions may not work) and open the .sln. Then build the solution as release. It should compile properly on the latest.

In the event that the tool cannot compile, check references. All the libraries are stored in Switch-Toolbox/Lib folder. 

- Smash Forge Devs (SMG, Ploaj,  jam1garner, smb123w64gb, etc) for some code ported over. Specifically animation stuff and some rendering.
- Assimp devs for their massive asset library!
- Wexos (helped figure out a few things, ie format list to assign each attribute)
- JuPaHe64 for the base 3D renderer.
- Every File Explorer devs (Gericom) for Yaz0 stuff
- Exelix for Byaml, Sarc and KCL library
- Syroot for helpful IO extensions and libraries
- GDKChan for PICA shaders stuff used with bcres, structs for bcres, and some DDS decode methods
- AboodXD for some foundation stuff with exelix's SARC library, Wii U (GPU7) and Switch (Tegra X1) textures swizzling, reading/converting uncompressed types for DDS, and documentation for GTX, XTX, and BNTX
- MelonSpeedruns for logo.
- BrawlBox team for brawl libaries used for brres parsing.

Resources
- [Treeview Icons by icons8](https://icons8.com/)
- Smash Forge (Currently placeholders)

Libraries
- [Brawl Lib (for brres section conversion)](https://github.com/libertyernie/brawltools)
- [Exelix (Sarc, kcl, and byml libraries)](https://github.com/exelix11/EditorCore/tree/master/FileFormatPlugins)
- [ZstdNet (Compression)](https://github.com/skbkontur/ZstdNet)
- [Be.HexEditor by Bernhard Elbl](https://sourceforge.net/projects/hexbox/)
- GL EditorFramwork by jupahe64
- [WeifenLuo for docking suite](http://dockpanelsuite.com/)
- [SF Graphics by SMG (Experimental](https://github.com/ScanMountGoat/SFGraphics) (currently just a placeholder for shader workflow and some useful things)
- [Audio & MIDI library](https://github.com/naudio/NAudio)
- [VGAudio](https://github.com/Thealexbarney/VGAudio)
- [CSCore](https://github.com/filoe/cscore)
- [Assimp](https://bitbucket.org/Starnick/assimpnet/src/master/)
- [OpenTK](https://github.com/opentk/opentk)
- [BezelEngineArchive Library](https://github.com/KillzXGaming/BEA-Library-Editor)
- [Syroot BinaryData](https://gitlab.com/Syroot/BinaryData)
- [Syroot Maths](https://gitlab.com/Syroot/Maths)
- [Syroot Bfres Library (Wii U)](https://gitlab.com/Syroot/NintenTools.Bfres)

License
 in Switch_Toolbox\Lib\Licenses
 
 Please note if you do not want your library used or if i'm missing credits!
Add readme 2019-03-23 17:05:47 +00:00			`# Switch-Toolbox`
Update README.md 2019-03-25 01:05:26 +00:00			`A tool to edit many formats of Nintendo Switch and Wii U.`
Add readme 2019-03-23 17:05:47 +00:00
Update README.md 2019-03-23 17:17:47 +00:00			`## Changelog 1.0 Experimental / BETA`
			`https://docs.google.com/spreadsheets/d/16JLhGBJL5U5hpKWspL-pzYIaRL23X1YKEmia6pbsGbc/edit#gid=1386834576`
Add readme 2019-03-23 17:05:47 +00:00
Update README.md 2019-03-29 01:05:08 +00:00			`## Releases`
			`https://github.com/KillzXGaming/Switch-Toolbox/releases`
Update README.md 2019-03-25 00:30:18 +00:00
Add readme 2019-03-23 17:05:47 +00:00			`## Features`

			`This tool currently features:`
			`- BFRES`
Update README.md 2019-03-25 01:05:26 +00:00			`- Fully supports Wii U and Switch.`
Add readme 2019-03-23 17:05:47 +00:00			`- Model importing (dae, fbx, obj, and csv)`
			`- Material editing (Render info, texture mapping, parameters, etc)`
Update README.md 2019-03-23 17:17:47 +00:00			`- Material copying`
Add readme 2019-03-23 17:05:47 +00:00			`- Animation and model sub section can be exported/imported.`
			`- Can delete, add, replace individual objects from an fmdl.`
			`- Can create new sub sections and data`
			`- Can preview skeletal, SRT, param, texture pattern, and bone visual animations. (Param ones will vary)`
Update README.md 2019-03-23 17:17:47 +00:00			`- Can export and import fully rigged models with bone support.`
			`- Can convert gif files to texture pattern animations. Very WIP atm.`
Update README.md 2019-05-03 20:04:14 +00:00
			`Can Edit Formats`
			`- BFRES`
Add readme 2019-03-23 17:05:47 +00:00			`- BNTX`
Update README.md 2019-05-03 20:04:14 +00:00			`- NUTEXB`
Update README.md 2019-04-30 21:03:53 +00:00			`- XTX`
Add readme 2019-03-23 17:05:47 +00:00			`- SARC`
			`- BARS`
			`- KCL`
Update README.md 2019-04-25 01:25:45 +00:00			`- BFFNT`
Update README.md 2019-04-25 01:26:05 +00:00			`- BFLIM`
Add readme 2019-03-23 17:05:47 +00:00			`- GFPAK`
			`- BEA`
Update README.md 2019-05-03 20:04:14 +00:00			`- AAMP (Wii U and Switch)`
Update README.md 2019-05-08 22:18:13 +00:00			`- BYAML/BYML (Wii U, 3DS, and Switch)`
			`- PTCL (Wii U, 3DS, and Switch)`
Update README.md 2019-05-03 20:04:14 +00:00			`- TMPK`

			`Can Preview`
Update README.md 2019-05-12 18:56:47 +00:00			`- BCRES`
			`- Models, materials, and textures.`
Add readme 2019-03-23 17:05:47 +00:00			`- BFSHA`
			`- Can view options, samplers, attributes, and uniform blocks.`
			`- BNSH`
			`- Can extract shader vertex and fragment shaders from variations/programs`
Update README.md 2019-03-23 17:17:47 +00:00			`- SHARCFB and SHARC`
			`- Basic preview of some shader program data.`
Update README.md 2019-05-03 19:58:03 +00:00			`- Can edit both v1 and v2 AAMP (Wii U and Switch)`
Update README.md 2019-04-25 01:25:45 +00:00			`- EFC`
			`- Can preview effect tables and link PTCL.`
			`- NUT`
			`- Can preview NTWU, NTP3, and NTWD variants. Editng will be soon`
			`- MSBT`
			`- Very basic previewing.`
Update README.md 2019-03-23 17:17:47 +00:00			`- TMPK`
			`- Can extract files and decompress`
Update README.md 2019-05-03 19:58:03 +00:00			`- Can save back.`
Update README.md 2019-03-23 17:17:47 +00:00			`- MP3, OGG, IDSP, HPS, WAV, BFWAV, BFSTM, BCWAV, BCWAV`
Update README.md 2019-03-23 17:18:12 +00:00			`- Can listen to audio and convert between certain formats. Thanks to VGAudio and CSCore`
Update README.md 2019-03-23 17:17:47 +00:00

Add readme 2019-03-23 17:05:47 +00:00
			`## Building`
			`To build make sure you have Visual Studio installed (I use 2017, older versions may not work) and open the .sln. Then build the solution as release. It should compile properly on the latest.`

			`In the event that the tool cannot compile, check references. All the libraries are stored in Switch-Toolbox/Lib folder.`

Update README.md 2019-05-12 18:56:47 +00:00			`- Smash Forge Devs (SMG, Ploaj, jam1garner, smb123w64gb, etc) for some code ported over. Specifically animation stuff and some rendering.`
Add readme 2019-03-23 17:05:47 +00:00			`- Assimp devs for their massive asset library!`
			`- Wexos (helped figure out a few things, ie format list to assign each attribute)`
			`- JuPaHe64 for the base 3D renderer.`
			`- Every File Explorer devs (Gericom) for Yaz0 stuff`
			`- Exelix for Byaml, Sarc and KCL library`
			`- Syroot for helpful IO extensions and libraries`
Update README.md 2019-05-12 18:56:47 +00:00			`- GDKChan for PICA shaders stuff used with bcres, structs for bcres, and some DDS decode methods`
Update README.md 2019-05-22 23:53:47 +00:00			`- AboodXD for some foundation stuff with exelix's SARC library, Wii U (GPU7) and Switch (Tegra X1) textures swizzling, reading/converting uncompressed types for DDS, and documentation for GTX, XTX, and BNTX`
Add readme 2019-03-23 17:05:47 +00:00			`- MelonSpeedruns for logo.`
Chr0 animation importing, dae exporting and tons more improvements! Chr0 can be imported/replaced. More fixes to importing sections including some errors and proper filtering. Dae epxorting now has a progress bar and an option to idsable texture exporting. Bfska can now be swapped between platforms. More sections will handle this method soon!. Fixed spaces on files from "Export All". Display multiple texture maps in bcres materials 2019-05-24 19:15:35 +00:00			`- BrawlBox team for brawl libaries used for brres parsing.`
Add readme 2019-03-23 17:05:47 +00:00
			`Resources`
			`- [Treeview Icons by icons8](https://icons8.com/)`
			`- Smash Forge (Currently placeholders)`

			`Libraries`
Chr0 animation importing, dae exporting and tons more improvements! Chr0 can be imported/replaced. More fixes to importing sections including some errors and proper filtering. Dae epxorting now has a progress bar and an option to idsable texture exporting. Bfska can now be swapped between platforms. More sections will handle this method soon!. Fixed spaces on files from "Export All". Display multiple texture maps in bcres materials 2019-05-24 19:15:35 +00:00			`- [Brawl Lib (for brres section conversion)](https://github.com/libertyernie/brawltools)`
Add readme 2019-03-23 17:05:47 +00:00			`- [Exelix (Sarc, kcl, and byml libraries)](https://github.com/exelix11/EditorCore/tree/master/FileFormatPlugins)`
			`- [ZstdNet (Compression)](https://github.com/skbkontur/ZstdNet)`
			`- [Be.HexEditor by Bernhard Elbl](https://sourceforge.net/projects/hexbox/)`
			`- GL EditorFramwork by jupahe64`
			`- [WeifenLuo for docking suite](http://dockpanelsuite.com/)`
			`- [SF Graphics by SMG (Experimental](https://github.com/ScanMountGoat/SFGraphics) (currently just a placeholder for shader workflow and some useful things)`
			`- [Audio & MIDI library](https://github.com/naudio/NAudio)`
			`- [VGAudio](https://github.com/Thealexbarney/VGAudio)`
Update README.md 2019-03-23 17:17:47 +00:00			`- [CSCore](https://github.com/filoe/cscore)`
Add readme 2019-03-23 17:05:47 +00:00			`- [Assimp](https://bitbucket.org/Starnick/assimpnet/src/master/)`
			`- [OpenTK](https://github.com/opentk/opentk)`
			`- [BezelEngineArchive Library](https://github.com/KillzXGaming/BEA-Library-Editor)`
			`- [Syroot BinaryData](https://gitlab.com/Syroot/BinaryData)`
			`- [Syroot Maths](https://gitlab.com/Syroot/Maths)`
			`- [Syroot Bfres Library (Wii U)](https://gitlab.com/Syroot/NintenTools.Bfres)`

			`License`
			`in Switch_Toolbox\Lib\Licenses`

			`Please note if you do not want your library used or if i'm missing credits!`