# Voxelman

**Repository Path**: zjwps/Voxelman

## Basic Information

- **Project Name**: Voxelman
- **Description**: Unity ECS + C# Job System example
- **Primary Language**: C#
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-10-18
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Voxelman
========

![gif](https://i.imgur.com/NxsT4AK.gif)
![gif](https://i.imgur.com/yrpIhfk.gif)

**Voxelman** is an example that shows how to use the new **[Entity Component
System]** with Unity in an extreme way. Each voxel in the scene is instantiated
as an entity, and controlled by component systems. It also utilizes the **C#
Job System**, the **Burst Compiler** and the **asynchronous raycast** to hit
the maximum efficiency of multi-core processors.

[Entity Component System]: https://github.com/Unity-Technologies/EntityComponentSystemSamples

System requirements
-------------------

- Unity 2018.2 or later

How to play with this project
-----------------------------

### Submodules

This repository uses [Git submodules] to manage UPM (Unity Package Manager)
packages. **If you know Git well and how to deal with submodules,** simply
clone this repository and do `submodule init` & `submodule update` in it.

**If you're not sure what Git submodule is,** download the contents of this
repository from [zip download link]. After extracting the zip file, download
and extract the following packages into the `Packages` directory.

- [jp.keijiro.cmu-mocap](https://github.com/keijiro/CMUMocap/archive/upm.zip)
- [jp.keijiro.klak](https://github.com/keijiro/Klak/archive/upm.zip)
- [jp.keijiro.neolowman](https://github.com/keijiro/NeoLowMan/archive/upm.zip)
- [jp.keijiro.test-assets](https://github.com/keijiro/jp.keijiro.test-assets/archive/master.zip)

[ECS repository]: https://github.com/Unity-Technologies/EntityComponentSystemSamples
[zip download link]: https://github.com/keijiro/Voxelman/archive/master.zip
[Git submodules]: https://git-scm.com/book/en/v2/Git-Tools-Submodules