@slugbugblue/trax 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# @slugbugblue/trax
+
+## 0.3.0
+
+Display a tentative move on the screen
+
+* Add `trax.tentative_icon()` function
+* `tty.display()` now accepts a tentative move
+
+## 0.2.0
+
+Breaking changes:
+
+* Converted from CommonJS to ESM
+* `trax.normalized` now prepends turn information to the string
+
+More convenience:
+
+* `trax.color`: the color of the player whose turn it is
+* `Trax.color_of[num]`: go from player number to color
+* `Trax.player_num[color]`: or from color to player number
+* `Trax.other[color]`: easily switch from 'w' to 'b' and back
+
+## 0.1.0
+
+Initial release:
+
+* engine.js
+  * create a new Trax game with `trax = new Trax()`
+  * play one move at a time with `trax.play('@0/')`
+  * ... etc
+
+* tty.js
+  * display a game with `tty.display(trax)`

package/README.md

@@ -26,7 +26,7 @@ The main Trax engine is provided as `engine.js`,
 which can be used as follows:
 
 ```javascript
-const Trax = require('@slugbugblue/trax')
+import Trax from '@slugbugblue/trax'
 
 let trax = new Trax()
 
@@ -48,7 +48,7 @@ until I get around to documenting the functionality.
 
 This project is built by [Chad Transtrum][ctrans]
 for [slugbugblue.com][sbb].
-Issues can be opened on the 
+Issues can be opened on the
 [gitlab project page][repo].
 
 ## Contributing
@@ -66,18 +66,21 @@ and for his generosity in allowing me to
 add the game to [GoldToken.com][goldtoken].
 
 Thanks to his widow Colleen Foley-Smith
-for extending that generosity
-to allow me to include Trax on [slugbugblue.com][sbb].
+for extending that courtesy
+to allow me to include Trax on [slugbugblue.com][sbb]
+as well.
 
 I would also like to extend a huge heartfelt appreciation
 to the magnanimous [Donald G. Bailey][dgb],
 who, through his excellent [book][traxbook],
-taught me the basics (and more!) of Trax
-and was always ready to share his insights
+taught me the basics (and more!) of Trax.
+I found him always ready to share his insights
 on the mechanics of the game,
-various approaches to encoding its complexities,
-and for his undeserved kindness
-in indulging my many questions.
+as well as various approaches to encoding its complexities.
+His undeserved kindness
+and infinite patience
+in indulging my many questions
+can never be repaid.
 
 ## License
 
@@ -98,7 +101,7 @@ limitations under the License.
 
 ## Trax rules copyright
 
-In the United States, game mechanics may not be copyrighted,
+In the United States, game mechanics may not be copyrighted;
 however, the specific wording of game rules does fall under copyright law.
 
 The official rules for Trax are found at http://traxgame.com/about_rules.php.

package/engine.js

@@ -431,8 +431,12 @@ const Trax = class {
     return this.position_code()
   }
 
+  tentative_icon (drops) {
+    return this.position_code(undefined, undefined, undefined, undefined, drops)
+  }
+
   // symmetry helper
-  position_code (right_to_left, bottom_to_top, rotate, swap_colors) {
+  position_code (right_to_left, bottom_to_top, rotate, swap_colors, drops) {
     const start_x = right_to_left ? this.right : this.left
     const start_y = bottom_to_top ? this.bottom : this.top
     const inc_x = right_to_left ? -1 : 1
@@ -451,6 +455,9 @@ const Trax = class {
         if (this.path.includes(this.tile_id(x, y))) {
           tile = String.fromCharCode(tile.charCodeAt(0) + this.turn * 6)
         }
+        if (drops && drops.dropped) {
+          if (drops.dropped.filter(t => t.x === x && t.y === y).length) tile = tile.toUpperCase()
+        }
         line += tile
       } else {
         line = add_blank(line)
@@ -504,6 +511,8 @@ const Trax = class {
 
 // add class methods
 Trax.column = encode_col
+
+// and class constants
 Trax.variants = variants
 Trax.color_of = color_of
 Trax.player_num = player_num

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slugbugblue/trax",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Trax game engine and friends",
   "keywords": [
     "trax",

package/tests.js

@@ -0,0 +1,11 @@
+import test from 'tape'
+import Trax from './engine.js'
+
+test('create trax game', t => {
+  let trax = new Trax('trax', '@0/', 'tape')
+  t.equal(trax.id, 'tape', 'id is assigned')
+  t.equal(trax.count, 1, '1 tile is played')
+  t.equal(trax.turn, 2, 'player 2 is next')
+  t.equal(trax.color, 'b', 'player 2 is black')
+  t.end()
+})

package/tty.js

@@ -38,6 +38,7 @@ const color_sets = {  // Colors for terminal sequence: <Esc>[38;5;<color_num>m
   trax: { b: 238, B: 57, e: 19, t: 74, w: 255, W: 184 },
   trax8: { b: 236, B: 21, e: 58, t: 137, w: 254, W: 117 },
   traxloop: { b: 235, B: 20, e: 17, t: 61, w: 253, W: 222 },
+  tentative: { b: 235, B: 18, e: 19, t: 244, w: 252, W: 217 },
 }
 
 const ln = 'm\u2584'  // lower half block -- with the leading m to terminate ansi color escape
@@ -62,6 +63,10 @@ const tiles = { a: 'bbww', b: 'bwbw', c: 'bwwb', d: 'wbbw', e: 'wbwb', f: 'wwbb'
 const tile_tty = (tile, top) => { // top: true for first line, false for second
   // quick access to tile color and its opposite in upper case
   let colors = { b: 'b', w: 'w', B: 'w', W: 'b' }
+  let save = set
+  let tentative = tile !== tile.toLowerCase()
+  if (tentative) set = color_sets.tentative
+  tile = tile.toLowerCase()
   if (!(tile in tiles)) { // winning paths are represented by adding 6 to the tile char code
     tile = String.fromCharCode(tile.charCodeAt(0) - 6)
     if (tile in tiles) {
@@ -73,19 +78,30 @@ const tile_tty = (tile, top) => { // top: true for first line, false for second
       colors.W = 'B'
     }
   }
+  let val = false
   if (tile in tiles) {
     tile = tiles[tile]
-    if (top) return uptty(colors[tile[0]])
-    let center_char = tile[1] === tile[2] ? rt : tile[2] === tile[3] ? lt : up
-    let centertty = dntty(colors[tile[2]], colors[tile[2].toUpperCase()], center_char)
-    return horiztty(colors[tile[3]]) + centertty + horiztty(colors[tile[1]]) + sp()
+    if (top) {
+      val = uptty(colors[tile[0]])
+    } else {
+      let center_char = tile[1] === tile[2] ? rt : tile[2] === tile[3] ? lt : up
+      let centertty = dntty(colors[tile[2]], colors[tile[2].toUpperCase()], center_char)
+      val = horiztty(colors[tile[3]]) + centertty + horiztty(colors[tile[1]]) + sp()
+    }
   }
-  if (top) return '??? '
-  return '\'\'\' '
+  set = save
+  return val || (top ? '??? ' : '\'\'\' ')
+}
+
+const merge_tentative = () => {
+  color_sets.tentative.e = set.e  // copy empty color to tentative set
+  color_sets.tentative.W = set.W
+  color_sets.tentative.B = set.B
 }
 
 const print_icon = (icon, set_name) => {
   set = color_sets[set_name] || color_sets.trax
+  merge_tentative(set)
   const on = esc + '38;5;' + String(set.t) + ';48;5;' + String(set.e) + 'm'
   let o1 = '   '
   let o2 = '1  '
@@ -153,19 +169,24 @@ const trax_game = (game='trax', moves) => {
   return trax
 }
 
-const display_game = (game='trax', moves='') => {
+const display_game = (game='trax', moves='', tentative) => {
   let trax = trax_game(game, moves)
+  let icon = trax.icon
+  if (tentative) {
+    let drops = trax.drop_tile(tentative)
+    icon = trax.tentative_icon(drops)
+  }
   console.info(trax.notation)
-  print_icon(trax.icon, trax.rules)
-  let name = {0: 'nobody', 1: 'white', 2: 'black'}[trax.turn]
+  print_icon(icon, trax.rules)
+  let name = {1: 'white', 2: 'black'}[trax.turn]
   if (trax.over) {
     if (trax.turn) {
       console.info(name + ' wins')
     } else {
-      console.info('game ended in a draw')
+      console.info('game end' + (tentative ? 's' : 'ed') + ' in a draw')
     }
   } else if (trax.turn) {
-    console.info(name +' to play')
+    console.info((tentative ? 'tentative position for ' : '') + name +' to play')
   }
 }