diff options
author | Alexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com> | 2022-11-05 14:46:11 +0300 |
---|---|---|
committer | Alexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com> | 2022-11-05 14:46:11 +0300 |
commit | accc2effac2ad9a53074367975e669e68cf11ceb (patch) | |
tree | 925aa381a754b6e3a756a95ea73d74775cbde766 | |
parent | e73d5ef3a7759d71f993b8425573e9fa92345875 (diff) |
Documentation
-rw-r--r-- | README.md | 23 |
1 files changed, 22 insertions, 1 deletions
@@ -1,4 +1,25 @@ # NesContainers -A simple .NET library for working with NES/Famicom containers: .nes (iNES, NES 2.0), .unf (UNIF) and .fds (Famicom Disk System images). +A simple .NET library for working with NES/Famicom ROM containers: .nes (iNES, NES 2.0), .unf (UNIF) and .fds (Famicom Disk System images). Full documentation: https://clusterm.github.io/nes-containers/ + +## Usage + +There are three classes for different type of containers. + +### .nes (iNES, NES 2.0) + +Most popular ROM container. + +Load ROM: `var nesfile = new NesFile(filename)` or `var nesfile = NesFile.FromFile(filename)` + +Access different fields: + +`nesfile.Mapper = 4;` // Set mapper + +`nesfile.PRG = new byte[32768]; // Set PRG data + +`nesfile.CHR = new byte[8192]; // Set CHR data + +`nesfile.Battery = true; // Enable battery saves + |