ihaveamac/ninfs
1
Fork 0
mirror of https://github.com/ihaveamac/ninfs.git synced 2025-06-18 08:55:34 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

update DEVELOPMENT.md about goals

Browse Source
This commit is contained in:
Ian Burgwin 2021-04-15 21:25:43 -07:00
parent 47d8990349
commit 6f621f80b9
No known key found for this signature in database
GPG Key ID: 90725113CA578EAA
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
DEVELOPMENT.md
View File

@ -1,5 +1,18 @@
This is a work in progress, please do not hesitate to contact me if there are any questions.
## Before you continue...
The focus of ninfs is to allow easy extraction of data from file types relevant to Nintendo consoles that would be useful mounting as a virtual filesystem.
### Goals
- File types that are standard on Nintendo consoles
- File types that are standard across games used on Nintendo consoles (e.g. darc)
- Standard/generic file types that are used often on Nintendo consoles (e.g. FAT32)
### Non-goals
- File types for other devices (e.g. Xbox or PlayStation), though ninfs can be used as a base for a separate project
- Creation of files (e.g. game or save file containers, NAND images)
- File types that would not be useful viewing as a filesystem (e.g. N64 ROMs due to the lack of a standard filesystem)
## Adding a new type
Each mount type is stored in `ninfs/mount/{type_name}.py`. "`type_name`" is a name such as `cia`, `nandctr` or `sd`.