diff --git a/README.md b/README.md index 0c65aab..89ffe58 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ ra.setZoom(8); ## Drawing pixels -Clearing the display can be done using the `fillBackground` method. Raster.js uses a limited color palette, just like many retro computer systems, limited to at most 256 colors. The default palette can be found in the "colors" section. Functions that require a color parameter, such as `fillBackground`, therefore only require a single numerical parameter, which uses that color from the palette. +Clearing the display can be done using the `fillBackground` method. Raster.js uses a limited color palette, just like many retro computer systems, limited to at most 256 colors. The default palette can be found in the "colors" section below. Functions that require a color parameter, such as `fillBackground`, therefore only require a single numerical parameter, which uses that color from the palette. ``` ra.fillBackground(12); @@ -155,6 +155,14 @@ Change the zoom level. Use a specific colorSet. See `useColors` in the docs for supported colorSets. +# Colors + +The current default colorset for raster.js is the "quick" palette, shown here: + +![](asset/quick-colorset.png) + +This is likely to change in a future version. Users should either add `ra.useColors('quick')` to their code, or be prepared to update the colors they use once this change happens. + # API See [the docs](docs.md) for the full documentation of the methods avaiable in raster.js. diff --git a/asset/quick-colorset.png b/asset/quick-colorset.png new file mode 100644 index 0000000..b736d26 Binary files /dev/null and b/asset/quick-colorset.png differ diff --git a/docs.md b/docs.md index b8837cd..2dd4cb7 100644 --- a/docs.md +++ b/docs.md @@ -33,8 +33,15 @@ Move the x,y coordinate system's origin to the center of the plane, instead of t Assigns the color set to use for displaying the scene. May either be the name of a pre-existing color set, or a list of rgb values. +If not invoked, the current default colorset is this: +![](asset/quick-colorset.png) + +This will likely change in the future: call `useColors('quick')` unless you want to modify your scripts in the future. + Names of pre-existing color sets: +`quick`: The current default colorset, shown above. 64 colors, a quick and simple rainbow palette. + `dos`: Colors used by the DOS operating system. TODO: Specify which video standard. `nes`: Colors used by the NES 8-bit console.