Added JSDoc strings.

.jsdoc.conf.json

@@ -0,0 +1,11 @@
+{
+  "plugins": ["plugins/markdown"],
+  "templates": {
+  	"systemName": "An Offline Life",
+  	"theme": "cosmo",
+  	"navType": "vertical",
+  	"inverseNav": true,
+  	"syntaxTheme": "dark",
+  	"search": false
+  }
+}

README.md

@@ -30,6 +30,11 @@ It makes use of the following works:
 * [Rollup][rollup] - without it I wouldn't have been able to piece together everything.
 * [Terser][terser] by [Fábio Santos][terser-creator] - it optimises the heck out of your code!
 
+## Documentation
+
+After cloning the repo and installing the deps, run `npm run doc` and look
+into the new `docs` directory.
+
 ## Known Issues
 
 If you are starting this app with a file: protocol under a Chromium-based

package.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "rollup -c",
     "check-filesize": "node scripts/check-filesize.js",
-    "doc": "jsdoc -d ./docs -p ./package.json -R README.md src",
+    "doc": "jsdoc -c .jsdoc.conf.json -d ./docs -p ./package.json -R README.md -t ./node_modules/ink-docstrap/template -r src",
     "lint": "npm run lint:css && npm run lint:js",
     "lint:css": "csscomb src/*.css",
     "lint:js": "standard src/*.js",
@@ -37,6 +37,7 @@
     "gh-pages": "1.2.0",
     "html-minifier": "3.5.20",
     "http-server": "0.11.1",
+    "ink-docstrap": "1.3.2",
     "jsdoc": "3.5.5",
     "pug": "2.0.3",
     "rollup": "0.65.0",

src/alias.js

@@ -1 +1,15 @@
+/**
+ * Kontra is a small game engine written for JS13kGames contests.
+ *
+ * @external kontra
+ * @see {@link https://straker.github.io/kontra/|kontra}
+ */
+
+/**
+ * In order to save some bytes, alias the global kontra object.
+ *
+ * @name k
+ * @global
+ * @alias kontra
+ */
 window.k = window.kontra

src/constants.js

@@ -1,26 +1,51 @@
+/**
+ * Defines constants used on several places in this game.
+ * However, since they are keys, they won't get minified.
+ * I'm sorry for the unreadable names, but they are saving bytes...
+ *
+ * @namespace
+ * @type object
+ * @property { object } constants    - Holding different values for the game.
+ * @property { string } constants.a  - Basename of the sound file.
+ * @property { string } constants.ae - Filename of the sound file.
+ * @property { string } constants.g  - Name of the ground layer used for tiles.
+ * @property { string } constants.t  - Basename of the tileset file.
+ * @property { string } constants.te - Filename of the tileset file.
+ * @property { number } constants.h  - Height of a tile in px.
+ * @property { number } constants.w  - Width of a tile in px.
+ * @property { number } constants.r  - Number of tiles in a row of the canvas.
+ * @property { number } constants.c  - Number of tiles in a col of the canvas.
+ * @property { number } constants.u  - ID of the tile not in the tileset.
+ * @property { number } constants.m  - ID of the modem tile.
+ * @property { number } constants.p  - ID of the pc tile with wire to top.
+ * @property { number } constants.b1 - 1st ID of button/switch tile (active).
+ * @property { number } constants.b2 - 2nd ID of button/switch tile (neutral).
+ * @property { number } constants.b3 - 3rd ID of button/switch tile (inactive).
+ * @property { number } constants.s1 - 1st ID of server tile (pos ok, num ok).
+ * @property { number } constants.s2 - 2nd ID of server tile (pos ok, num nok).
+ * @property { number } constants.s3 - 3rd ID of server tile (pos nok, num nok).
+ */
 const constants = {
-  // Assets
-  a: 'd', // audio (dial-up)
-  ae: 'd.mp3', // audio with extension
-  g: 'g', // ground layer
-  t: 't', // tileset
-  te: 't.png', // tileset with extension
+  a: 'd',
+  ae: 'd.mp3',
+  g: 'g',
+  t: 't',
+  te: 't.png',
 
-  // World
-  h: 32, // height of a tile
-  w: 32, // width of a tile
-  r: 9, // tiles in a row
-  c: 9, // riles in a column
+  h: 32,
+  w: 32,
+  r: 9,
+  c: 9,
 
-  u: 0, // unset tile id
-  m: 16, // modem id
-  p: 12, // personal computer id
-  b1: 13, // button in active position
-  b2: 14, // button in neutral position
-  b3: 15, // button in deactive position
-  s1: 9, // server with correct position and value
-  s2: 10, // server with correct position, but wrong value
-  s3: 11 // server with neither correct position nor value
+  u: 0,
+  m: 16,
+  p: 12,
+  b1: 13,
+  b2: 14,
+  b3: 15,
+  s1: 9,
+  s2: 10,
+  s3: 11
 }
 
 export default constants

src/index.js

@@ -8,6 +8,13 @@ const gameLoopOptions = {
   update
 }
 
+/**
+ * Starts the game.
+ *
+ * @requires module:render
+ * @requires module:update
+ * @requires module:loadAssets
+ */
 loadAssets().then(() => {
   k.init()
 

src/render.js

@@ -3,6 +3,24 @@ import factory from './sprites/factory'
 import store from './store'
 import tilesets from './tilesets'
 
+/**
+ * Renders the game every frame.
+ *
+ * @module render
+ * @exports render
+ * @requires constants
+ * @requires module:sprites/factory
+ * @requires module:store
+ * @requires module:tilesets
+ */
+
+/**
+ * Delegates the rendering to specialised methods.
+ * Creates some transparent sprites for click handling.
+ * 
+ * @public
+ * @function
+ */
 const render = function () {
   const { gm } = store.state()
   const tiles = tilesets()