diff options
| author | Alexey 'Cluster' Avdyukhin <clusterrr@clusterrr.com> | 2022-10-25 22:51:45 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-25 22:51:45 +0300 |
| commit | 93df662c81f62bf9477d33fc2550ab49997e7cfc (patch) | |
| tree | fa60a40264c8f30492012412b70ddff0c3113298 | |
| parent | 0982322d9c4a66da2e0a3b4a3872ed4574db1f93 (diff) | |
README.md for examples
| -rw-r--r-- | Examples/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/Examples/README.md b/Examples/README.md index 23079fc..66bb725 100644 --- a/Examples/README.md +++ b/Examples/README.md @@ -1,3 +1,30 @@ # NesTiler usage examples
+[**nesasm CE**](https://github.com/ClusterM/nesasm) and **make** are required to compile those examples.
+## nrom_simple
+Very simple example with only one full screen image. Demo image is very simple and uses <256 tiles, so there are no need for any bankswitching.
+
+## nrom_simple_offset
+Same as **nrom_simple** but image is cropped, so attribute table bytes are displaced (**--attribute-table-y-offset-#** option).
+
+## nrom_group_scroll
+This example uses two images with shared pattern table (**--share-pattern-table** option), <256 tiles totally, so it's possible to scroll them.
+
+## nrom_split
+This example uses single image splitted in two horizontally, each part uses it's own pattern table, <256 tiles each. Base nametable switches during image rendering, so it's possible to use 512 tiles in total.
+
+## nrom_split_lossy
+Same as **nrom_split** but with сomplicated image that doesn't fit NES colors limitations, so NesTiler tries to optimize it and dismiss some palettes and colors (**--lossy** option).
+
+## mmc3_split4
+This example uses single image splitted into four horizontally. Each part uses it's own pattern table, <256 tiles each. MMC3 IRQs and bankswitching used to switch pattern tables on the respective lines, so it's possible to remove 256 tiles limitation at all.
+
+## mmc3_split2_animation
+Full screen animation. Two images splitted into two parts horizontally. MMC3 IRQs and bankswitching used to switch pattern tables on the respective lines.
+
+## sprites8x8
+Simple 8x8 sprites example.
+
+## sprites8x16
+Simple 8x16 sprites example.
|