cubing.js

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

Twizzle

Twizzle is the spiritual successor to alg.cubing.net, based on cubing.js. It is currently being developed at src/sites/alpha.twizzle.net.

See the Twizzle Diaries video series for more information on Twizzle's vision and use cases.

Getting started

If you aren't sure where to get started, you should start with cdn.cubing.net, which lets you implement cubing.js in a website.

If you're already comfortable with writing web apps using npm, see the "Using with Node.js" section below.

The following code is a good way to get started with cdn.cubing.net:

<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.

Using with Node.js

If you would like to use cubing.js as a library in your Node projects, make sure you have node and npm installed (installing node will install npm as well). Once you have installed those, you can run:

npm install cubing

The following modules are a good starting point:

import { Alg } from "cubing/alg";
import { TwistyPlayer } from "cubing/twisty";

Contributing

Developing cubing.js

If you would like to contribute to the development of cubing.js, please refer to our contribution guidelines.

To work on the cubing.js source code, you'll need to install node and npm (installing node will install npm as well). Once you have installed those, you can run:

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

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

The core library code for cubing.js is in src/cubing. To test changes, use:

make test

• 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.

Acknowledgments

As of this time, cubing.js primarily contains code by Lucas Garron (@lgarron) and Tom Rokicki (@rokicki). Significant parts of the cubing code also are from:

• Chen Shuang (@cs0x7f): Scramblers for 3x3x3, 4x4x4, and Square-1
• xyxxy (@torchlight): Scramblers for unofficial events

It also uses the three.js, comlink, and p-lazy libraries.

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.