cubing.js

cubing.js is a collection of Javascript libraries, still under development.

Twizzle

Twizzle is based on cubing.js, and is currently being developed at src/sites/alpha.twizzle.net.

Documentation

If you want to display algs or solves, the following code is a good way to get started:

<script
  src="https://cdn.cubing.net/js/cubing/twisty"
  type="module"
></script>
<twisty-player alg="R U R' U R U2' R'"></twisty-player>

You can find more documentation at js.cubing.net/cubing/.
The source for the documentation site is currently inside the docs folder of this repository.

Development

Development relies on node and npm. Once you have installed those, you can run:

git clone https://github.com/cubing/cubing.js && cd cubing.js
make dev

This should run npm install and start the server, after which you can open http://localhost:3333/. Some tips:

• See src/README.md for the source code structure.
  • The core library code for cubing.js is in src/cubing.
  • The code for Twizzle and dev experiments is in src/sites.
• To test changes, run: make test

License

This project is licensed under the GPL license (version 3 or later). This means that this library is free to use, although you must publish any code that uses it (e.g. also put it on GitHub). See the full license for exact details.

We've selected this license in order to encourage the cubing community to work on software in a way so that everyone can contribute and extend each other's work.