Mirrors/Switch-Toolbox
2
0
Fork 0
mirror of https://github.com/KillzXGaming/Switch-Toolbox synced 2024-11-26 06:20:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Minor README fixes

Browse source
This commit is contained in:
Xenoq 2019-11-18 02:14:41 -05:00 committed by GitHub
parent 1f37e182b5
commit 094f467ed8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 55 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

111
README.md
View file

@ -1,5 +1,5 @@
# Switch-Toolbox
A tool to edit many formats of Nintendo Switch and Wii U.
A tool to edit many formats of Nintendo Switch, 3DS and Wii U.
## Changelog 1.0 Experimental / BETA
https://docs.google.com/spreadsheets/d/16JLhGBJL5U5hpKWspL-pzYIaRL23X1YKEmia6pbsGbc/edit#gid=1386834576
@ -14,18 +14,18 @@ https://discord.gg/eyvGXWP
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)
- 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.
- 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 preview skeletal, SRT, param, texture pattern, and bone visual animations. (param animations 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
Can edit formats:
- BFRES
- BNTX
- BFLYT
@ -39,33 +39,32 @@ Can Edit Formats
- BFLIM
- GFPAK
- BEA
- AAMP (Wii U and Switch)
- BYAML/BYML (Wii U, 3DS, and Switch)
- PTCL (Wii U, 3DS, and Switch)
- AAMP (Switch, 3DS and Wii U)
- BYAML/BYML (Switch, 3DS and Wii U)
- PTCL (Switch, 3DS and Wii U)
- TMPK
- PAK/IGA (Crash Bandicoot/Crash Team Racing)
- IGZ Textures (Crash Bandicoot/Crash Team Racing)
- PAK / IGA (Crash Bandicoot / Crash Team Racing)
- IGZ Textures (Crash Bandicoot / Crash Team Racing)
- BFFNT (Textures only)
Can Preview
Can preview:
- BCRES
- Models, materials, and textures.
* Models, materials, and textures.
- BFSHA
- Can view options, samplers, attributes, and uniform blocks.
* Can view options, samplers, attributes, and uniform blocks.
- BNSH
- Can extract shader vertex and fragment shaders from variations/programs
* 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)
* 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.
* Can preview effect tables and link PTCL.
- NUT
- Can preview NTWU, NTP3, and NTWD variants. Editng will be soon
* Can preview NTWU, NTP3, and NTWD variants. Editing will be implemented soon.
- MSBT
- Very basic previewing.
* Very basic previewing.
- MP3, OGG, IDSP, HPS, WAV, BFWAV, BFSTM, BCWAV, BCWAV
- Can listen to audio and convert between certain formats. Thanks to VGAudio and CSCore
* Can listen to audio and convert between certain formats. Thanks to VGAudio and CSCore
- NARC
- SP2 (Team Sonic Racing)
- GFMDL
@ -82,19 +81,19 @@ Can Preview
- GMX (TPHD Models)
- MKAGPDX Model .bin files
- MKAGPDX Archive .pac files
- ME01 and SA01 archives.
- Luigi's Mansion 2 Dark Moon (archives, models, and textures)
- ME01 and SA01 archives
- Luigi's Mansion 2: Dark Moon (archives, models, and textures)
- TPL
- TXE
- BTI
- G1T
- CMB (OOT3D, MM3D, LM3DS)
- CTXB (OOT3D, MM3D, LM3DS)
- GAR (OOT3D, MM3D, LM3DS)
- ZSI (OOT3D, MM3D)
- CMB (OoT3D, MM3D, LM3DS)
- CTXB (OoT3D, MM3D, LM3DS)
- GAR (OoT3D, MM3D, LM3DS)
- ZSI (OoT3D, MM3D)
- BinGZ (Hyrule Warriors)
- PAC (Sonic Forces)
- Gamecube ISOs (file system)
- GameCube ISOs (file system)
## Tutorials
@ -104,31 +103,31 @@ https://github.com/KillzXGaming/Switch-Toolbox/wiki
https://github.com/KillzXGaming/Switch-Toolbox/issues
## 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.
To build make sure you have Visual Studio installed (I use 2017, older versions may not work) and open the solution (.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.
In the event that the tool cannot compile, check references. All the libraries used are stored in Switch-Toolbox/Lib folder.
## Credits
- Smash Forge Devs (SMG, Ploaj, jam1garner, smb123w64gb, etc) for some code ported over. Specifically animation stuff and some rendering.
- Smash Forge Devs (SMG, Ploaj, jam1garner, smb123w64gb, etc.) for some code ported over, specifically animation stuff and some rendering.
- Ploaj for a base on the DAE writer.
- Assimp devs for their massive asset library!
- Wexos (helped figure out a few things, ie format list to assign each attribute)
- Wexos (helped figure out a few things, i.e. format list to assign each attribute)
- JuPaHe64 for the base 3D renderer.
- Every File Explorer devs (Gericom) for Yaz0 and bitmap font 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.
- Every File Explorer devs (Gericom) for Yaz0 and bitmap font 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 Switch Toolbox logo.
- BrawlBox team for brawl libraries used for BRRES parsing.
- Sage of Mirrors for SuperBMDLib.
- Ambrosia for BTI and TXE support.
- Kuriimu for some IO and file parsing help
- Skyth and Radfordhound for PAC documentation
- Kuriimu for some IO and file parsing help.
- Skyth and Radfordhound for PAC documentation.
## Resources
- [Treeview Icons by icons8](https://icons8.com/)
- [TreeView Icons by icons8](https://icons8.com/)
- Smash Forge (Currently placeholders)
## Documentation (File Formats)
@ -138,15 +137,15 @@ In the event that the tool cannot compile, check references. All the libraries a
- http://Avsys.xyz/wiki/Category:File_Formats
## Libraries
- [SuperBMDLib] (https://github.com/Sage-of-Mirrors/SuperBMD)
- [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)
- [SuperBMDLib](https://github.com/Sage-of-Mirrors/SuperBMD)
- [BrawlLib (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
- [GL Editor Framework by jupahe64](https://github.com/jupahe64/GL_EditorFramework)
- [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)
- [SF Graphics by SMG (experimental)](https://github.com/ScanMountGoat/SFGraphics) (currently just a placeholder for shader workflow and some useful things)
- [NAudio (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/)
@ -154,11 +153,11 @@ In the event that the tool cannot compile, check references. All the libraries a
- [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)
- [Syroot BFRES Library (Wii U)](https://gitlab.com/Syroot/NintenTools.Bfres)
- [LibHac](https://github.com/Thealexbarney/LibHac)
## Helpful Tools
- https://github.com/IcySon55/Kuriimu
- [Kuriimu](https://github.com/IcySon55/Kuriimu)
License
in Switch_Toolbox\Lib\Licenses