Update Readme (#50)

Got rid of outdated information, the tool is more than sufficient to explain it visually, added intensity on/off description, updated spec of max w/h
This commit is contained in:
birdybro
2022-01-06 13:42:37 -07:00
committed by GitHub
parent f0963fe3cf
commit e18df05289

107
README.md
View File

@@ -4,53 +4,74 @@ 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.
Automated Method: Run the [Downloader.sh](https://github.com/MiSTer-devel/Downloader_MiSTer/raw/main/downloader.sh) script to receive the most up to date ShadowMasks placed in the proper folder.
## Color Palette
Manual Method: 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 | 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
```
## Create Your Own
With the tool found here: [MiSTer - Shadow Mask Editor](https://bool.space/mister/ShadowMaskEditor.htm)
Tool provided by [Tonurics](https://github.com/tonurics)
## Specifications
### Dimensions
Max width = 16
Max Height = 16
### Color Palette
| Color | Value |
| ------- | ----- |
| Gray | 0 |
| Blue | 1 |
| Green | 2 |
| Cyan | 3 |
| Red | 4 |
| Magenta | 5 |
| Yellow | 6 |
| White | 7 |
### Intensity On
| % | Value |
| ------ | ----- |
| 100 | 0 |
| 106.25 | 1 |
| 112.25 | 2 |
| 118.75 | 3 |
| 125 | 4 |
| 131.25 | 5 |
| 137.5 | 6 |
| 143.75 | 7 |
| 150 | 8 |
| 156.25 | 9 |
| 162.5 | a |
| 168.75 | b |
| 175 | c |
| 181.25 | d |
| 187.5 | e |
| 193.75 | f |
### Intensity Off
| % | Value |
| ------ | ----- |
| 0 | 0 |
| 6.25 | 1 |
| 12.5 | 2 |
| 18.75 | 3 |
| 25 | 4 |
| 31.25 | 5 |
| 37.5 | 6 |
| 43.75 | 7 |
| 50 | 8 |
| 56.25 | 9 |
| 62.5 | a |
| 68.75 | b |
| 75 | c |
| 81.25 | d |
| 87.5 | e |
| 93.75 | f |