diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4f18c6 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Shadow Masks for [MiSTer FPGA](https://github.com/MiSTer-devel/Main_MiSTer/wiki) + +This repository contains the Shadow Mask files for the MiSTer FPGA. + +## Instructions + +Create a folder named `Shadow_Masks` in the root of your MicroSD Card along with the other folders like "filters", "games", etc... Place the .txt Shadow Mask files into that folder. + +## Color Palette + +| Color | Value | Bits | +| --- | --- | --- | +| Gray | 0 | 000 | +| Blue | 1 | 001 | +| Green | 2 | 010 | +| Cyan | 3 | 011 | +| Red | 4 | 100 | +| Magenta | 5 | 101 | +| Yellow | 6 | 110 | +| White | 7 | 111 | + +Max width = 8 +Max Height = 8 + +## How It Works + +Here's an example. If you wanted to make RGB dots that use this pattern: + +![](example.png) + +Then you would make a file like this: + +``` +# w,h +6,4 + +# lut +4,4,2,2,1,1 +4,4,2,2,1,1 +2,1,1,4,4,2 +2,1,1,4,4,2 +``` + +These numbers correspond to the following r, g, b values like this: + +``` +r,r,g,g,b,b +r,r,g,g,b,b +g,b,b,r,r,g +g,b,b,r,r,g +``` diff --git a/Magenta-Green Stripes.txt b/Shadow_Masks/Magenta-Green Stripes.txt similarity index 100% rename from Magenta-Green Stripes.txt rename to Shadow_Masks/Magenta-Green Stripes.txt diff --git a/Shadow_Masks/Misc/NECT Slot Mask.txt b/Shadow_Masks/Misc/NECT Slot Mask.txt new file mode 100644 index 0000000..4750a7c --- /dev/null +++ b/Shadow_Masks/Misc/NECT Slot Mask.txt @@ -0,0 +1,11 @@ +# w,h +8,6 + +# lut +4,2,1,0,4,2,1,0 +4,2,1,0,4,2,1,0 +4,2,1,0,0,0,0,0 +4,2,1,0,4,2,1,0 +4,2,1,0,4,2,1,0 +0,0,0,0,4,2,1,0 + diff --git a/Shadow_Masks/Misc/Round Dot Mask - Brighter.txt b/Shadow_Masks/Misc/Round Dot Mask - Brighter.txt new file mode 100644 index 0000000..51ead28 --- /dev/null +++ b/Shadow_Masks/Misc/Round Dot Mask - Brighter.txt @@ -0,0 +1,8 @@ +# w,h +6,4 + +# lut +3,0,5,0,6,0 +0,0,0,0,0,0 +0,6,0,3,0,5 +0,0,0,0,0,0 diff --git a/Shadow_Masks/Misc/Round Dot Mask.txt b/Shadow_Masks/Misc/Round Dot Mask.txt new file mode 100644 index 0000000..747649a --- /dev/null +++ b/Shadow_Masks/Misc/Round Dot Mask.txt @@ -0,0 +1,9 @@ +# w,h +6,4 + +# lut +4,0,2,0,1,0 +0,0,0,0,0,0 +0,1,0,4,0,2 +0,0,0,0,0,0 + diff --git a/Monochrome Stripes.txt b/Shadow_Masks/Monochrome Stripes.txt similarity index 100% rename from Monochrome Stripes.txt rename to Shadow_Masks/Monochrome Stripes.txt diff --git a/RYCB Stripes.txt b/Shadow_Masks/RYCB Stripes.txt similarity index 100% rename from RYCB Stripes.txt rename to Shadow_Masks/RYCB Stripes.txt diff --git a/Squished VGA.txt b/Shadow_Masks/Squished VGA.txt similarity index 100% rename from Squished VGA.txt rename to Shadow_Masks/Squished VGA.txt diff --git a/Thin RGB Stripes.txt b/Shadow_Masks/Thin RGB Stripes.txt similarity index 100% rename from Thin RGB Stripes.txt rename to Shadow_Masks/Thin RGB Stripes.txt diff --git a/VGA.txt b/Shadow_Masks/VGA.txt similarity index 100% rename from VGA.txt rename to Shadow_Masks/VGA.txt diff --git a/example.png b/example.png new file mode 100644 index 0000000..fe56139 Binary files /dev/null and b/example.png differ