Giter VIP home page Giter VIP logo

vloxy-docs's Introduction

Vloxy Engine

GitHub release (latest by date) OpenUPM Build Status GitHub Workflow Status GitHub YouTube Channel Subscribers

Performance oriented voxel engine for unity.

This repository holds the documentation, source code for the engine can be found here

Goals

Description Done
Jobs & Burst
Extensible Api
Serialization
Streaming & Infinite generation
Noise Generation System
Physics & Fluids
Networking

Demos

Along with package releases a demo application showcasing the capabilities is also released for the following platforms

  • Windows
  • Android

Head over to the release page to check them out

Quick Start

  • Get started by installing Vloxy Engine using one of the following methods
    • Unity Package latest can be found here
    • OpenUPM, more info can be found here
openupm add io.codeblaze.vloxyengine

While UPM is supported via OpenUPM, it is still recommended to add Vloxy Engine directly to the project as a package. With source access you would get the maximum control and freedom to tune the engine to your use case.

  • Make sure the following dependencies are installed, they should be installed automatically regardless of the way you install Vloxy Engine

  • After the package is imported you can open up one of the sample scene or import one of the world pre-fabe into your current scene. in case you go the pre-fabe route make sure to set the focus parameter on the world object around which the world would be generated.

Documentation & Dev-logs

Documentation can be found here, and it's source code is hosted here

I'll try to create dev-logs for the major features in development as well as some tutorials which you can find on my YouTube or on the Vloxy Engine blog

Docs Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn install

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

vloxy-docs's People

Contributors

blazekill avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.