arcanumcube 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2024 mawxiwtz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+“Software”), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# Arcanum Cube
+
+Arcanum Cube is a cube puzzle module written in Typescript. Supports creation and manipulation of WebGL mesh groups.
+
+## Usage
+
+1. import Three.js and arcanumcube
+
+```
+import * as THREE from 'three';
+import * as ARCCUBE from 'arcanumcube';
+```
+
+2. create a cube object
+
+```
+const arccube = new ARCCUBE.WebGLArcanumCube();
+await arccube.init();
+const arccubeGroup = arccube.getGroup();
+arccubeGroup.position.set(0, 0, 0);
+scene.add(arccubeGroup);
+
+renderer.setAnimationLoop((time) => {
+    :
+
+    // animate twisting
+    arccube.updateTweens();
+
+    renderer.render(scene, camera);
+});
+```
+
+3. operations
+
+```
+// scramble 30 steps
+arccube.scramble(30);
+// twist 'U' direction
+arccube.tweenTwist('U');
+// reset
+arccube.reset();
+```
+
+## License
+
+Released under the MIT license
+
+Copyright (c) 2024 mawxiwtz