Files
ctrff-pub/README.md
tobid7 f5a58278db Add support to more color formats
- RGBA4444: fully working
- RGBA5551: fully not working
- LA8, LA4: fully working
2026-01-08 18:59:47 +01:00

47 lines
1.2 KiB
Markdown

# ctrff
Tool/Library to work with Nintendo 3ds File formats
## Note
**CTRFF Requires Palladium Headers from branch devel040 (as this is the branch the lib was latest tested with)**
## Building
- Desktop OS
```bash
# Note that -DCTRFF_DESKTOP is not required to build the lib for desktop
cmake -B build . -DCTRFF_DESKTOP=ON -DCMAKE_BUILD_TYPE=Release
cd build
make
```
- Nintendo 3ds
```bash
# Probably should go for Debug (to debug crashes)
# You could also do --toolchain path/to/debkitpro/cmake/3DS.cmake
# instead of -DCTRFF_3DS=ON
cmake -B build . -DCTRFF_3DS=ON -DCMAKE_BUILD_TYPE=Release
cd build
make
```
## File Formats
Not all Planned formates are listed here yet
| Format | State | Notes |
| ------ | ----- | ----- |
| 3dsx | Basic Loading and Viewing of Meta Data Smdh | |
| bcstm | Loading of almost every Data | Fully done and playable by BCSTM-Player |
| bcwav | Basic Loading (not tested yet) | Not finished yet |
| bclim | Creating A4,A8,LA4,LA8,L4,L8,RGB24,RGBA32,RGBA4444,RGB565 done | WIP |
| lz11 | Encoder done, Decoder missing | WIP |
| romfs | Nothing Done yet (Started creating header) | |
| smdh | Almost done | missing safetey checks |
| cbmd | Nothing done yet | |
| cgfx | Nothing Done yet | |
| darc | Nothing done yet | |