From 93df662c81f62bf9477d33fc2550ab49997e7cfc Mon Sep 17 00:00:00 2001 From: Alexey 'Cluster' Avdyukhin Date: Tue, 25 Oct 2022 23:51:45 +0400 Subject: README.md for examples --- Examples/README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) 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. -- cgit v1.2.3 From bd9f6c1fb18fcd5f6e91ae43987fa5193b336413 Mon Sep 17 00:00:00 2001 From: Alexey 'Cluster' Avdyukhin Date: Wed, 26 Oct 2022 00:04:06 +0400 Subject: Images in examples readme file --- Examples/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Examples/README.md b/Examples/README.md index 66bb725..83f8770 100644 --- a/Examples/README.md +++ b/Examples/README.md @@ -5,21 +5,32 @@ ## 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. +![Image](../TestImages/Images/blaster_master_right.png) + ## 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. +![Image](../TestImages/Images/blaster_master_left.png)![Image](../TestImages/Images/blaster_master_right.png) + ## 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. +![Image](../TestImages/Images/jurassic.png) + ## 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). +![Image](../TestImages/Images/me.png) -> ![Image](https://user-images.githubusercontent.com/4236181/197870408-4472a362-2829-4c74-baaf-1c27c082d070.png) + + ## 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. +![Image](../TestImages/Images/myatej.gif) + ## 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. -- cgit v1.2.3