export to npm module

Author: cs0x7f

Makefile

@@ -2,6 +2,9 @@ src = src
 ifndef dest
 	dest = dist
 endif
+ifndef destnpm
+	destnpm = npm_export
+endif
 closure = lib/compiler.jar
 externJQ = --externs lib/jquery-1.7.js
 externTwisty = --externs $(dest)/js/twisty.js
@@ -138,7 +141,7 @@ worker.js)
 
 cstimer = $(dest)/js/cstimer.js
 twisty = $(dest)/js/twisty.js
-cstimer_module = $(dest)/js/cstimer_module.js
+cstimer_module = $(destnpm)/cstimer_module.js
 css = $(addprefix $(dest)/css/, $(shell ls $(src)/css))
 langJS = $(addprefix $(dest)/lang/, $(shell ls $(src)/lang/ | grep .*\.js))
 langPHP = $(addprefix $(dest)/lang/, $(shell ls $(src)/lang/ | grep .*\.php))

npm_export/README.md

@@ -0,0 +1,51 @@
+# csTimer module
+The csTimer module is a function library that individually package some functions in csTimer.
+
+Currently it only includes some of the scrambl functions supported by csTimer, and more functions will be supported later.
+
+The csTimer module is part of csTimer and shares the same source code as csTimer: https://github.com/cs0x7f/cstimer
+
+## Install
+
+```bash
+# install
+npm i cstimer_module
+```
+
+## Usage
+
+```javascript
+var cstimer = require('cstimer_module');
+
+// List all scramble types
+console.log(cstimer.getScrambleTypes());
+
+// Generate random-state 3x3x3 scramble
+console.log(cstimer.getScramble('333'));
+
+// Generate scrambles for all wca events
+var wca_events = [
+	["3x3x3", "333", 0],
+	["2x2x2", "222so", 0],
+	["4x4x4", "444wca", 0],
+	["5x5x5", "555wca", 60],
+	["6x6x6", "666wca", 80],
+	["7x7x7", "777wca", 100],
+	["3x3 bld", "333ni", 0],
+	["3x3 fm", "333fm", 0],
+	["3x3 oh", "333", 0],
+	["clock", "clkwca", 0],
+	["megaminx", "mgmp", 70],
+	["pyraminx", "pyrso", 10],
+	["skewb", "skbso", 0],
+	["sq1", "sqrs", 0],
+	["4x4 bld", "444bld", 40],
+	["5x5 bld", "555bld", 60],
+	["3x3 mbld", "r3ni", 5]
+];
+
+for (var i = 0; i < wca_events.length; i++) {
+	var param = wca_events[i];
+	console.log(param[0] + ': ', cstimer.getScramble(param[1] /*scramble type*/, param[2] /*scramble length*/));
+}
+```

npm_export/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "cstimer_module",
+  "version": "0.0.2",
+  "description": "scramble and tools used in csTimer",
+  "main": "cstimer_module.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "Rubik's Cube"
+  ],
+  "author": "cs0x7f",
+  "license": "GPL-3.0"
+}