From 660096ccc4e99eaa60c1b94e13f5031addf7760c Mon Sep 17 00:00:00 2001 From: punkfairie Date: Sun, 14 May 2023 11:35:23 -0700 Subject: [PATCH] Writing README. --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bcf6dc9..9713801 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ -# elite-matrix -A small library for working with the Elite Dangerous color matrix. +# Elite Matrix +A (very) small library for working with the Elite Dangerous color matrix in javascript. Types +included! + +Adapted from [EDScout's color adjuster][ed-scout]. + +# Usage +`npm i elite-matrix` + +The input matrix is stored in an EliteMatrix object, and must be passed in as three arrays, one for +each line in the matrix, each containing three numbers. + +A GraphicsConfiguration.xml that looks like this: +```xml + 1, 0, 0 + 0, 1, 0 + 0, 0, 1 +``` + +Would need to be translated into this and passed to EliteMatrix: +```javascript +import { EliteMatrix } from 'elite-matrix'; + +const matrixRed = [1, 0, 0]; +const matrixGreen = [0, 1, 0]; +const matrixBlue = [0, 0, 1]; +const matrix = new EliteMatrix(matrixRed, matrixGreen, matrixBlue); +``` + +From there you can use the `EliteMatrix` object to apply color filters. `filterColor` accepts either +a string hex color, or an RGB array. It will return in a matching format. + +[ed-scout]: https://github.com/joncage/ed-scout/blob/master/EDScoutWebUI/HudColourAdjuster.py#L37 \ No newline at end of file