Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mik14a committed Feb 2, 2018
1 parent 551a4a9 commit f70c81f
Showing 1 changed file with 32 additions and 24 deletions.
56 changes: 32 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,85 @@
# VOX4U

MagicaVoxel VOX Format import plugin for UE4
[![GitHub release](https://img.shields.io/github/release/mik14a/VOX4U/all.svg)](https://github.com/mik14a/VOX4U/releases)

---

Import [MagicaVoxel](https://voxel.codeplex.com) vox format file to [Unreal Engine 4](https://www.unrealengine.com/).
Import [MagicaVoxel](https://ephtracy.github.io/) vox format file to [Unreal
Engine 4](https://www.unrealengine.com/).

## Requirement

Unreal Engine 4.18 or later.
Unreal Engine 4 4.18 or later.

## Description

Import voxel objects to StaticMesh, DestructibleMesh or Voxel.
No need to use digital content creation tool.
Import voxel objects to StaticMesh, DestructibleMesh or Voxel. No need to use
other digital content creation tool.

### StaticMesh

![StaticMesh](https://pbs.twimg.com/media/DUm7N_UVMAA5aw1.jpg)

Generate static mesh from voxel data,
texture from vox file or default palette
Generate static mesh from voxel data, texture from vox file or default palette
and generate simple material for the mesh.

Can layout to the world.

#### Mesh optimized

![optimized](https://pbs.twimg.com/media/DUm7PYxVwAIZzeZ.jpg)
![Optimized](https://pbs.twimg.com/media/DUm7PYxVwAIZzeZ.jpg)

Mesh generation use [a monotone decomposition algorithm](https://0fps.net/2012/07/07/meshing-minecraft-part-2/).
Mesh generation use [a monotone decomposition
algorithm](https://0fps.net/2012/07/07/meshing-minecraft-part-2/).

### DestructibleMesh

![DestructibleMesh](https://pbs.twimg.com/media/CgKuBudUIAAbyAg.jpg)

Generate destructible mesh from voxel data
and fracture meshes to destructible component,
texture from vox file or default palette
and generate simple material for the mesh.
Generate destructible mesh from voxel data and fracture meshes to destructible
component, texture from vox file or default palette and generate simple material
for the mesh.

Can layout and destruct to cell use PhysX not use [APEX Destruction PhysXLab](https://developer.nvidia.com/apex-destruction-physxlab-tutorials).
Can layout and destruct to cell use PhysX not use [APEX Destruction
PhysXLab](https://developer.nvidia.com/apex-destruction-physxlab-tutorials).

### Voxel
### Voxel (Experimental support)

![Voxel](https://pbs.twimg.com/media/ChdPpU3UcAEaGr0.jpg)

Generate voxel asset based instanced static mesh component
and auto generate cube mesh and material to use to call per palette.
Generate voxel asset based instanced static mesh component and auto generate
cube mesh and material to use to call per palette.

Can use middle size building blocks or rideable terrain on the world.

If no need to access to Voxal Actor. Can remove runtime module from uplugin and
packaging with out runtime module.

## Demo

First person template based [demo](https://twitter.com/twitter/statuses/727524080082014208).
First person template based
[demo](https://twitter.com/twitter/statuses/727524080082014208).

## Usage

Drag & Drop vox file to content panel or open import dialog and select MagicaVoxel(*.vox) files.
Drag & Drop vox file to content panel or open import dialog and select
MagicaVoxel(*.vox) files.

## Install

```sh
cd {YourUnrealProject}
git clone https://github.com/mik14a/VOX4U.git ./Plugins/VOX4U
```

or
Or add submodule to your project.

```
```sh
cd {YourUnrealProject}
git submodule add https://github.com/mik14a/VOX4U.git ./Plugins/VOX4U
```

Binary relase is [Here](https://github.com/mik14a/VOX4U/releases).
Binary relase is [Here](https://github.com/mik14a/VOX4U/releases). Download and
copy binaries to {YourUnrealProject}/Plugins/VOX4U. If create package without
c++ access. Copy to _Engine/Plugins/Runtime_ directory.

## Licence

Expand Down

0 comments on commit f70c81f

Please sign in to comment.