From 33c2fe43097f174a81647e9b10574c7a341df99e Mon Sep 17 00:00:00 2001
From: heinezen <heinezen@hotmail.de>
Date: Mon, 15 Feb 2021 14:30:40 +0100
Subject: [PATCH] doc: Palette definition file.

---
 doc/media/openage/blendtable_format_spec.md |   2 +-
 doc/media/openage/palette_format_spec.md    | 108 ++++++++++++++++++++
 2 files changed, 109 insertions(+), 1 deletion(-)
 create mode 100644 doc/media/openage/palette_format_spec.md

diff --git a/doc/media/openage/blendtable_format_spec.md b/doc/media/openage/blendtable_format_spec.md
index 4a4df31695..528269cd30 100644
--- a/doc/media/openage/blendtable_format_spec.md
+++ b/doc/media/openage/blendtable_format_spec.md
@@ -76,7 +76,7 @@ There has to be exactly one `blendtable` defined.
 
 Parameter | Type    | Optional | Default value
 ----------|---------|----------|--------------
-matrix    | int[][] | No       | -
+matrix    | int[]   | No       | -
 
 **matrix**<br>
 A `n`x`n` matrix containing reference IDs for blending patterns. This
diff --git a/doc/media/openage/palette_format_spec.md b/doc/media/openage/palette_format_spec.md
new file mode 100644
index 0000000000..adf7ca75c5
--- /dev/null
+++ b/doc/media/openage/palette_format_spec.md
@@ -0,0 +1,108 @@
+# Palette Format Specification
+
+**Format Version:** 1
+
+The openage palette format is a plaintext configuration file format for defining
+colour palettes. It tells the openage renderer a table of predefined RGBA colour values
+that can be used for special pixels such as player colour pixels.
+
+All attributes start with a defined keyword followed by parameter values. Some
+parameters have default values and are optional. The preferred file extension is
+`.opal`.
+
+
+## Quick Reference
+
+```
+# This is a palette configuration file
+# comments start with # and are ignored
+
+# file version
+version 1
+
+# number of entries in the colour table
+entries <int>
+
+# Colour values
+colours [
+<int> <int> <int> <int>
+...
+]
+```
+
+
+## Data Type Formatting
+
+Type     | Example | Description
+---------|---------|---------
+int      | `5`     | Signed Integer
+
+
+## Attributes
+
+### `version`
+
+Version of the palette format. Increments every time the syntax
+or keywords of the format change.
+
+Parameter  | Type   | Optional | Default value
+-----------|--------|----------|--------------
+version_no | int    | No       | -
+
+**version_no**<br>
+Version number of the format.
+
+
+#### Example
+
+```
+version 1
+```
+
+
+### `entries`
+
+Defines the number of colour values in the palette.
+There has to be exactly one `entries` defined.
+
+Parameter  | Type   | Optional | Default value
+-----------|--------|----------|--------------
+count      | int    | No       | -
+
+**count**<br>
+Number of colour values in the palette.
+
+
+#### Example
+
+```
+count 256
+```
+
+
+### `colours`
+
+Defines the array containing the colour values.
+There has to be exactly one `colours` defined.
+
+Parameter  | Type    | Optional | Default value
+-----------|---------|----------|--------------
+values     | int[]   | No       | -
+
+**values**<br>
+An array of integer values in the range of `0` to `255`. Every palette
+entry is a 4-tuple of integers, with each value representing a channel
+byte value for an *RGBA* color.
+
+The parameter array must contain exactly `count * 4` values where `count`
+is the parameter value from the `entries` attribute.
+
+
+#### Example
+
+```
+colours [
+255 255 255 0
+4 3 2 1
+]
+```