diff --git a/site/mods/Pixi/index.html b/site/mods/Pixi/index.html index 674d464..661395d 100644 --- a/site/mods/Pixi/index.html +++ b/site/mods/Pixi/index.html @@ -93,6 +93,14 @@

For example, if you want to import a robot from the CRF called Pixi Art, execute the command PixiBot "Pixi Art" to load the robot into your Gamecraft game world.

+

+ Under the hood, PixiBot and PixiBotFile read the Robocraft robot save format from the CRF and places the equivalent Gamecraft blocks. + For blocks which are in Gamecraft and Robocraft (full cubes, prisms, etc.), direct conversion occurs. + If a block does not have a single-block equivalent in Gamecraft, the conversion algorithm will attempt to substitute in an existing blueprint for the block. + Failing that, a text block with the name of the Robocraft block will be placed in its place. + Currently Pixi comes with blueprints for struts, rods and wheels, but support for more blocks is ongoing. + If you'd like a certain block blueprint to be added to Pixi, please contact NGnius on the Exmods Discord server. +

@@ -120,7 +128,18 @@

For example, if you want to import an image called pixi_art.png that's stored in Gamecraft's installation directory, execute the command Pixi2D "pixi_art.png" to load the image as blocks. - It's important to include the file extension, since Pixi isn't capable of any black magic. + It's important to include the file extension, since Pixi isn't capable of black magic. +

+

+ Image to blocks conversion with Pixi2D read a file in PNG or JPG format and converts every pixel to the nearest Gamecraft block colour. + Adjacent blocks with the same colour are converted into a single scaled block to reduce the performance impact from larger images. + The combination of colour quantization and optimisation usually results in a 50-75% reduction in block count for an image (compared to 1 block per pixel). +

+

+ Image to text conversion with PixiText and PixiConsole converts every pixel from a PNG or JPG image file into a coloured square text character. + This process does not optimise for similar adjacent pixels, so images will become more than 10x larger when converted to text. + As a result, images larger than 64x64 pixels are very likely to cause issues with Gamecraft performance and stability. + To ensure that everyone can enjoy your game, and to avoid save corruption, use Pixi's image to text commands sparingly and only for small images.