tixyz

A minimalist three-dimensional coding environment. Control 8x8x8 dots with a single JavaScript function.

🔴 Give it a whirl at https://doersino.github.io/tixyz/ or check out some examples!

Let me be abundantly clear: This thing is wholly derivative, merely adding a third dimension to Martin Kleppe's creative code golfing tool tixy by mashing it up with David DeSandro's Zdog. Those two deserve any and all credit.

Development

Setup

Fairly typical for a modern JavaScript thing. If you're just starting out with that toolchain, first install a reasonably recent release of Node.js – it's almost certainly available through your package manager. Then:

$ git clone https://github.com/doersino/tixyz
$ cd tixyz
$ npm install

If you don't regularly work with Node.js, make sure ./node_modules/.bin/ is on your path:

export PATH="./node_modules/.bin:$PATH"

Workin' it

Open src/index.js (or whatever file you want to work on) in your preferred text editor. Then execute:

$ npm run start

This will automatically build the project, fire up a basic web server, and ask your browser to navigate to it. Whenever you save any changes now, the project will be rebuilt and – like magic – your browser will refresh the page.

Build & Deploy

If you want to generate a static version, run the following command:

$ npm run build

To deploy it on GitHub Pages, execute:

$ npm run deploy

This will first revert the dist/ directory to a clean slate, then do npm run build, and finally use the gh-pages package to commit the now-current dist/ directory to the gh-pages branch of this repository (it will create it if it doesn't already exist).

License

According to tixy's package.json, it's licensed under the ISC License. I don't think the changes I've made to it are sufficient for licensing tixyz any differently.