ExMods/Pixi
1
0
Fork 0
Code Issues 4 Pull requests Projects Releases 8 Packages Wiki Activity

Update README install instructions

Browse source
This commit is contained in:
NGnius (Graham) 2020-05-25 09:05:49 -04:00
parent 72386d2c53
commit e8ca1fe398
2 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Pixi/Images/ImageCommands.cs
View file

@ -206,8 +206,8 @@ namespace Pixi.Images
ConsoleBlock console = ConsoleBlock.PlaceNew(position); ConsoleBlock console = ConsoleBlock.PlaceNew(position);
// set console's command // set console's command
console.Command = "ChangeTextBlockCommand"; console.Command = "ChangeTextBlockCommand";
console.Arg1 = textBlockId; console.Arg1 = "\"" + textBlockId + "\"";
console.Arg2 = text; console.Arg2 = "\"" + text + "\"";
console.Arg3 = ""; console.Arg3 = "";
} }
} }

13
README.md
View file

@ -5,12 +5,14 @@ Think of it like automatic pixel art.
## Installation ## Installation
To install the Pixi mod, copy `Pixi.dll` (from the latest release) into the `Plugins` folder in Gamecraft's main folder. Before installing Pixi, please patch Gamecraft with [GCIPA](https://git.exmods.org/modtainers/GCIPA/releases) and install the latest version of [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI/releases).
You'll also need [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI) installed and Gamecraft patched with [GCIPA](https://git.exmods.org/modtainers/GCIPA/releases).
To install Pixi, copy `Pixi.dll` (from the latest release) into the `Plugins` folder in Gamecraft's main folder.
Alternately, follow the install guide: https://www.exmods.org/guides/install.html (ignore the part about a zip file -- move Pixi.dll into the Plugins folder instead).
## Usage ## Usage
Pixi adds new commands to Gamecraft's command line to import images into a game. Pixi adds new commands to Gamecraft's command line to import images (and more) into a game.
Since Pixi places vanilla Gamecraft blocks, imported images should be visible without Pixi installed. Since Pixi places vanilla Gamecraft blocks, imported images should be visible without Pixi installed.
### Commands ### Commands
@ -49,13 +51,14 @@ The default thickness is 1.
### Behaviour ### Behaviour
PixiText and PixiConsole share the same image conversion system. PixiText and PixiConsole share the same image conversion system.
The conversion system converts every pixel to a [<color> tag](http://digitalnativestudios.com/textmeshpro/docs/rich-text/#color) followed by a square text character. The conversion system converts every pixel to a [color tag](http://digitalnativestudios.com/textmeshpro/docs/rich-text/#color) followed by a square text character.
Thanks to TextMeshPro's support for the full colour spectrum, colour accuracy for these commands is very good.
For PixiText, the resulting character string is set to the text field of the text block that the command places. For PixiText, the resulting character string is set to the text field of the text block that the command places.
For PixiConsole, the character string is automatically set to a console block in the form `ChangeTextBlockCommand [text block id] [character string]`. For PixiConsole, the character string is automatically set to a console block in the form `ChangeTextBlockCommand [text block id] [character string]`.
Pixi2D takes an image file and converts every pixel to a coloured block. Pixi2D takes an image file and converts every pixel to a coloured block.
Unfortunately, an image file supports over 6 million colours and Gamecraft only has 100 paint colours (and only 90 are used by Pixi2D). Unfortunately, an image file supports over 6 million colours and Gamecraft only has 100 paint colours (and only 90 are used by Pixi2D).
Pixi2D uses an algorithm to convert each pixel an image into the closest paint colour, but colour accuracy will never be as good as a regular image. Pixi2D uses an algorithm to convert each pixel in an image into the closest paint colour, but colour accuracy will never be as good as a regular image.
Pixi2D's colour-conversion algorithm also uses pixel transparency so you can cut out shapes. Pixi2D's colour-conversion algorithm also uses pixel transparency so you can cut out shapes.
A pixel which has opacity of less than 50% will be ignored. A pixel which has opacity of less than 50% will be ignored.