Ashes

(β˜… 345)

WebGL2.0 3D Engine - Global Illumination - RayTracing

  • .gitignore
  • .gitmodules
  • .npmignore
  • .travis.yml
  • bvh.html
  • demo.html
  • gltfsamples
  • index.html
  • LICENSE
  • package.json
  • README.md
  • rollup.config.js
  • tsconfig.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/but0n/Ashes

Downloads the entire project code from GitHub to your computer.

cd Ashes

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g yarn

Installs the package published on the npm registry globally β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
<script src="https://cdn.jsdelivr.net/npm/ashes3d/build/ashes.main.js"></script>

Type this command into your terminal and run it.

npm i ashes3d

Type this command into your terminal and run it.

npm install -g yarn

Installs the package published on the npm registry globally β€” no need to clone the source.

yarn

Downloads and installs the libraries listed in package.json.

yarn dev

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation