Update README

This commit is contained in:
Docker VM 2024-07-19 20:18:49 -04:00
parent b3d697eaf7
commit 8049f10b65

View File

@ -1,6 +1,6 @@
# Pixel Placer Bot
This README provides an overview of the Pixel Placer Bot, a simple bot designed to read Twitch chat and modify the colors of cells on a 16 x 16 grid.
Pixel Placer Bot, is a designed to read Twitch chat and modify the colors of cells on a 16 x 16 grid.
## Introduction
@ -12,6 +12,7 @@ ## Features
- Grid manipulation: The bot modifies the colors of cells on a 16 x 16 grid based on the received commands.
- Command parsing: The bot parses the commands received from Twitch chat and maps them to specific cells on the grid.
- Color customization: The bot supports a variety of colors, allowing viewers to create unique pixel art on the grid.
- Easily integrated into OBS' Browser Source
## Getting Started
@ -37,6 +38,29 @@ ## Command Syntax
- `<color>`: The color to assign to the cell (e.g., red, blue, green).
### Default Colors
```json
{
"white": "#FFFFFF",
"lightGray": "#E4E4E4",
"mediumGray": "#888888",
"darkGray": "#222222",
"pink": "#FFA7D1",
"red": "#E50000",
"orange": "#E59500",
"brown": "#A06A42",
"yellow": "#E5D900",
"lightGreen": "#94E044",
"green": "#02BE01",
"cyan": "#00D3DD",
"blue": "#0083C7",
"darkBlue": "#0000EA",
"purple": "#CF6EE4",
"darkPurple": "#820080",
"black": "#000000"
}
```
<!-- white -->
!place A 1 <span style="color:#FFFFFF">white</span>