Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update to new Setup information
  • Loading branch information
Arlorean committed Aug 8, 2017
1 parent cc20b05 commit 38fd858
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,40 @@
# Voxels

C# utilities for reading/writing/rendering [MagicaVoxel](https://ephtracy.github.io/) [.vox files](https://github.com/ephtracy/voxel-model/blob/master/MagicaVoxel-file-format-vox.txt).
C# utilities for reading/writing/rendering [MagicaVoxel](https://ephtracy.github.io/) [.vox files](https://github.com/ephtracy/voxel-model/blob/master/MagicaVoxel-file-format-vox.txt).

# Windows Explorer Thumbnails

The [Voxels.Installer.msi](https://github.com/Arlorean/Voxels/releases/download/v1.0.0.3/Voxels.Installer.msi) provides Windows Explorer Thumbnails for MagicaVoxel .vox files:
The [Voxels.Setup.exe](https://github.com/Arlorean/Voxels/releases/download/v1.1/Voxels.Setup.exe) provides Windows Explorer Thumbnails for MagicaVoxel .vox files:

![Windows Explorer Thumbnails](Voxels.Website/WindowsExplorer.png)

The library uses [SkiaSharp](https://github.com/mono/SkiaSharp#using-skiasharp) which requires [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145) to be installed. The exe setup does this for you.

# PNG and SVG output

The Voxels.CommandLine tool converts .vox files to .png and .svg. Here is my example [wizard.vox](Voxels.CommandLine/wizard.vox) file converted:
The Voxels.CommandLine.exe tool converts .vox files to .png and .svg (512x512). Here is my example [wizard.vox](Voxels.CommandLine/wizard.vox) file converted:

PNG | SVG
----------------|-------------------------
![PNG](Voxels.Website/wizard.png) | ![SVG](https://cdn.rawgit.com/Arlorean/Voxels/df6f605a/Voxels.Website/wizard.svg)

# Quick Build
# Command Line Build

1. Install ``Visual Studio 2017``
1. Open ``Voxels.sln``
1. Set ``Voxels.CommandLine`` as the startup project
1. Set ``Debug -> Command line arguments`` to be ``wizard.vox``
1. Press ``Start`` in Visual Studio 2017
1. Open Windows Explorer on the ``Voxels.CommandLine\bin\Debug directory``
1. There should be two new files: ``wizard.png`` and ``wizard.svg``

# Installer Build
# Setup Build

1. Install ``Visual Studio 2017``
1. Open ``Voxels.sln``
1. Install [WiX Toolset](http://wixtoolset.org/) v3.11
1. Install [Wix Toolset Visual Studio 2017 Extension](https://marketplace.visualstudio.com/items?itemName=RobMensching.WixToolsetVisualStudio2017Extension)
1. Build ``Voxels.Installer`` to create the [Voxels.Installer.msi](https://github.com/Arlorean/Voxels/releases/download/v1.0.0.3/Voxels.Installer.msi) setup file.
1. Build ``Voxels.Setup`` to create the [Voxels.Setup.exe](https://github.com/Arlorean/Voxels/releases/download/v1.1/Voxels.Setup.exe) setup file.

# Third Party Credits

Expand All @@ -40,6 +43,7 @@ PNG | SVG
1. [SharpShellTools](https://github.com/dwmkerr/sharpshell) - Dave Kerr's ShellExtensions Tools for .NET
1. [WiX Toolset](http://wixtoolset.org/) - ~~Simple~~ XML based windows installer scripting
1. [Ambient Occlusion](https://0fps.net/2013/07/03/ambient-occlusion-for-minecraft-like-worlds/) algorithm by [Mikola Lysenko](https://github.com/mikolalysenko).
1. [Wix VC++ 2015 Setup](https://gist.github.com/nathancorvussolis/6852ba282647aeb0c5c00e742e28eb48) gist for

The 3x3x3.vox, 8x8x8.vox files are directly from the [MagicaVoxel](https://ephtracy.github.io/) distribution for authentic testing.

Expand Down

0 comments on commit 38fd858

Please sign in to comment.