Browse Source

Improve Pixi behaviour info

master
NGnius 4 years ago
parent
commit
8df21b07d0
1 changed files with 20 additions and 1 deletions
  1. +20
    -1
      site/mods/Pixi/index.html

+ 20
- 1
site/mods/Pixi/index.html View File

@@ -93,6 +93,14 @@
<p><span class="tab"></span>
For example, if you want to import a robot from the CRF called Pixi Art, execute the command <span style="display:inline-block;"><i><b>PixiBot "Pixi Art"</b></i></span> to load the robot into your Gamecraft game world.
</p>
<p><span class="tab"></span>
Under the hood, <i><b>PixiBot</b></i> and <i><b>PixiBotFile</b></i> read the Robocraft robot save format from the <a href="https://factory.robocraftgame.com/">CRF</a> 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 <a href="https://discord.exmods.org">Exmods Discord server</a>.
</p>
</div>
<div style="background-image: url('../../mods/Pixi/img-pixi-gc2.png'); background-size: 100%; background-position: bottom; background-repeat: no-repeat;">
<img src="../../mods/Pixi/img-pixi-gc2.png" width="100%" style="visibility: hidden; vertical-align: middle;" />
@@ -120,7 +128,18 @@
</p>
<p><span class="tab"></span>
For example, if you want to import an image called <i>pixi_art.png</i> that's stored in Gamecraft's installation directory, execute the command <span style="display:inline-block;"><i><b>Pixi2D "pixi_art.png"</b></i></span> 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.
</p>
<p><span class="tab"></span>
Image to blocks conversion with <i><b>Pixi2D</b></i> 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).
</p>
<p><span class="tab"></span>
Image to text conversion with <i><b>PixiText</b></i> and <i><b>PixiConsole</b></i> 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.
</p>
</div>
<div class="content-header" id="pixi-dev">


Loading…
Cancel
Save