@slugbugblue/trax 0.13.0 → 0.15.0

package/src/cmds/list.js

@@ -40,9 +40,6 @@ export const listCmd = {
   ],
 }
 
-const plural = (n, noun, nouns) =>
-  n + ' ' + (Math.abs(n) === 1 ? noun : nouns || noun + 's')
-
 const alphaSort = (a, b) => {
   a = String(a).toLowerCase()
   b = String(b).toLowerCase()
@@ -104,6 +101,9 @@ listCmd.fn = (CLI, ...filters) => {
     return CLI.error('No games. Type "new" to start a new game.')
   }
 
+  const puzzle = filters.find((f) => f.length > 1 && 'puzzles'.startsWith(f))
+  if (puzzle) return CLI.do('puzzles', ...filters.filter((f) => f !== puzzle))
+
   let list = []
   const size = {
     id: 1,
@@ -120,7 +120,7 @@ listCmd.fn = (CLI, ...filters) => {
       id: (game.id === CLI.GAME.id ? '* #' : '#') + String(game.id),
       name: game.name?.length || 0,
       rules: game.rules,
-      moves: plural(moves, 'move'),
+      moves: CLI.plural(moves, 'move'),
       smoves: game.over ? '9999' : String(moves).padStart(9, '0'),
       sturn: String(game.turn),
       p1: game.players?.[0] || 'white',

package/src/cmds/new.js

@@ -42,7 +42,7 @@ const pairs = [
   ['Donald', 'Daisy'],
   ['Fred', 'Barney'],
   ['Fred', 'George'],
-  ['Frodo', 'Sam'],
+  ['Frodo', 'Samwise'],
   ['Han', 'Chewie'],
   ['Harry', 'Ron'],
   ['Holmes', 'Watson'],
@@ -98,6 +98,9 @@ newCmd.fn = (CLI, variant, ...names) => {
   let rules = ''
   if (variant) {
     variant = variant.toLowerCase()
+    if (variant.length > 1 && 'puzzles'.startsWith(variant)) {
+      return CLI.do('puzzles', 'new', ...names)
+    }
 
     if (['8x8', '8', 'trax8x8', '8trax', '8x8trax'].includes(variant)) {
       rules = 'trax8'

package/src/cmds/play-try.js

@@ -15,6 +15,8 @@
 
 // CLI play/try commands
 
+import { suggest } from '@slugbugblue/trax/analyst'
+
 const moveRx = /^\d+\.?$/
 const notationRx = /^[@a-z]+\d+[bps/\\+]$/i
 
@@ -46,6 +48,40 @@ export const tryCmd = {
   ],
 }
 
+const bot = (CLI) => {
+  const game = CLI.GAME
+  const trax = CLI.TRAX
+  const players = game.players || ['a', 'b']
+  const name = players[trax.turn - 1]
+  if (trax.over && game.puzzle) {
+    if (trax.move <= game.max && name !== 'puzzlebot') {
+      CLI.puzzleSolved(game.puzzle)
+      return 'win'
+    }
+
+    return 'lose'
+  }
+
+  if (!trax.over && /bot\b/i.test(name)) {
+    if (game.puzzle && trax.move >= game.max) {
+      trax.play('puzzled')
+      return 'lose'
+    }
+
+    CLI.do('view')
+    CLI.out(CLI.bubble(trax.color + 'd', `${name} thinking...`))
+    const move = suggest(trax)?.pick?.move
+    if (move) {
+      CLI.out(CLI.bubble(trax.color + 'd', `${name} chooses ${move}`))
+      trax.play(move)
+    }
+
+    if (game.puzzle) return ' and win by move ' + String(game.max)
+  }
+
+  return ''
+}
+
 playCmd.fn = (CLI, ...moves) => {
   if (moves.length === 0 || !moves[0]) {
     CLI.error('You must provide a move.')
@@ -56,24 +92,27 @@ playCmd.fn = (CLI, ...moves) => {
     CLI.do('new')
   }
 
-  if (CLI.TRAX.over) {
+  const game = CLI.GAME
+  const trax = CLI.TRAX
+
+  if (trax.over) {
     return CLI.error('The game is over.')
   }
 
-  const start = CLI.TRAX.move
+  const start = trax.move
   let checkMove
 
   for (let move of moves) {
     if (notationRx.test(move)) {
-      const moveNumber = CLI.TRAX.move
+      const moveNumber = trax.move
       move = CLI.fixNotation(move)
       if (checkMove) {
-        CLI.TRAX.play(checkMove, move)
+        trax.play(checkMove, move)
       } else {
-        CLI.TRAX.play(move)
+        trax.play(move)
       }
 
-      if (CLI.TRAX.move === moveNumber) {
+      if (trax.move === moveNumber) {
         CLI.error(
           'Move "' +
             (checkMove ? checkMove + '. ' : '') +
@@ -88,9 +127,17 @@ playCmd.fn = (CLI, ...moves) => {
     }
   }
 
-  if (CLI.TRAX.move !== start) {
+  if (trax.move !== start) {
+    const result = bot(CLI)
     CLI.updateGameData()
     CLI.do('view')
+    if (result === 'lose') {
+      CLI.error('Failed to complete puzzle ' + game.puzzle)
+    } else if (result === 'win') {
+      CLI.out(CLI.color.success('You completed puzzle ' + game.puzzle))
+    } else if (result) {
+      CLI.out(result)
+    }
   }
 }
 

package/src/cmds/puzzles.js

@@ -0,0 +1,158 @@
+/** @file Puzzles CLI
+ * @copyright 2022
+ * @author Chad Transtrum <chad@transtrum.net>
+ * @license Apache-2.0
+ */
+
+import { Trax } from '@slugbugblue/trax'
+import { levels, puzzles, sources } from '@slugbugblue/trax/puzzles'
+
+let maxLevel = 0
+const puzzleIds = []
+for (const puzzle of puzzles) {
+  maxLevel = Math.max(maxLevel, puzzle.level)
+  puzzleIds.push(puzzle.id)
+}
+
+const validLevels = levels.slice(0, maxLevel + 1)
+const completions = [...validLevels, ...puzzleIds].join('|')
+
+export const puzzlesCmd = {
+  name: 'puzzles',
+  args: '["list"|"start"] [level|puzzle]',
+  comp: 'list|ls|new|show|start|view ' + completions,
+  desc: 'play puzzles',
+  help: [
+    'Practice your skills with puzzles. Use "list" to see the puzzle',
+    'categories, or "start" to play a puzzle.',
+  ],
+}
+
+const an = (word = '') => {
+  const a = /^[aeiou]/.test(word) ? 'an' : 'a'
+  return a + ' ' + word
+}
+
+const showPuzzle = (CLI, id) => {
+  const puzzle = puzzles.find((p) => p.id === id)
+  if (!puzzle) return CLI.error(`Puzzle ${id} not found`)
+  const trax = new Trax(puzzle.game, puzzle.notation, 'cli')
+  const players = ['white', 'black']
+  CLI.display(trax, players)
+  let out = CLI.color.short(puzzle.id)
+  out += CLI.color(` is ${an(levels[puzzle.level])} puzzle`) + '\n'
+  if (puzzle.title) out += CLI.color(puzzle.title) + '\n'
+  if (puzzle.desc) out += CLI.color.help(puzzle.desc) + '\n'
+  out += CLI.color(players[puzzle.player - 1] + ' to win by move ' + puzzle.max)
+  const src = sources[puzzle.src]
+  if (src) {
+    let source = '\nPuzzle '
+    source += src.copyright
+      ? 'copyright ' + src.copyright + ' by'
+      : 'courtesy of'
+    source += ' ' + src.name
+    const url = src.url ? ' ' + CLI.color.white(src.url) : ''
+    out += CLI.color.black(source) + url
+  }
+
+  CLI.out(out)
+}
+
+const listPuzzles = (CLI) => {
+  let size = 1
+  const data = []
+  for (const name of validLevels) {
+    size = Math.max(size, name.length)
+    data.push({ name, count: 0, solved: 0, selected: false })
+  }
+
+  if (data[CLI.puzzleLevel]) data[CLI.puzzleLevel].selected = true
+
+  for (const puzzle of puzzles) {
+    data[puzzle.level].count += 1
+    if (CLI.puzzle(puzzle.id).solved > 0) data[puzzle.level].solved += 1
+  }
+
+  for (const category of data) {
+    let out = category.selected ? CLI.color('* ') : '  '
+    out += CLI.color.short(category.name.padEnd(size + 1))
+    if (category.solved === 0) {
+      out += CLI.color(CLI.plural(category.count, 'puzzle'))
+    } else if (category.solved === category.count) {
+      if (category.count > 3) out += CLI.color.success('all ')
+      out += CLI.color.success(CLI.plural(category.count, 'puzzle') + ' solved')
+    } else {
+      out += CLI.color.success(`${category.solved} solved`)
+      out += CLI.color(` of ${category.count} puzzles`)
+    }
+
+    CLI.out(out)
+  }
+}
+
+const listLevel = (CLI, levelName) => {
+  let size = 1
+  const level = levels.indexOf(levelName)
+  const data = []
+  for (const puzzle of puzzles) {
+    if (puzzle.level !== level) continue
+    size = Math.max(size, puzzle.id.length)
+    data.push({
+      id: puzzle.id,
+      title: puzzle.title,
+      solved: CLI.puzzle(puzzle.id).solved > 0,
+    })
+  }
+
+  for (const puzzle of data) {
+    let out = CLI.color.success(puzzle.solved ? '✓' : ' ')
+    out += CLI.color.short(' ' + puzzle.id)
+    if (puzzle.title) out += CLI.color(' ' + puzzle.title)
+    CLI.out(out)
+  }
+}
+
+const startPuzzle = (CLI, puzzle) => {
+  const id = CLI.newPuzzle(puzzle)
+  CLI.out(CLI.color(`Started puzzle ${puzzle.id} as game #${id}`))
+  showPuzzle(CLI, puzzle.id)
+}
+
+const startNextPuzzle = (CLI, level) => {
+  if (level === undefined) level = CLI.puzzleLevel
+  const unsolved = puzzles.filter((p) => !CLI.puzzle(p.id).solved)
+  if (unsolved.length === 0) {
+    CLI.out(CLI.success('You have already completed all the puzzles.'))
+    return CLI.error('Specify a specific puzzle to try one again.')
+  }
+
+  const next = unsolved.find((p) => p.level >= level) || unsolved[0]
+  startPuzzle(CLI, next)
+}
+
+puzzlesCmd.fn = (CLI, action, id) => {
+  action = action?.toLowerCase() ?? 'list'
+  if ('start'.startsWith(action) || 'new'.startsWith(action)) {
+    if (!id) return startNextPuzzle(CLI)
+
+    const puzzle = puzzles.find((p) => p.id === id)
+    if (puzzle) {
+      return startPuzzle(CLI, puzzle)
+    }
+
+    if (validLevels.includes(id)) {
+      return startNextPuzzle(CLI, levels.indexOf(id))
+    }
+
+    return CLI.error('Could not start puzzle ' + id)
+  }
+
+  if (action) {
+    const x = id || action
+    if (validLevels.includes(x)) return listLevel(CLI, x)
+    if (puzzleIds.includes(x)) return showPuzzle(CLI, x)
+    if (id) return CLI.error('Could not find puzzle ' + id)
+  }
+
+  listPuzzles(CLI)
+}

package/src/cmds/suggest.js

@@ -36,7 +36,7 @@ suggestCmd.fn = (CLI, debug) => {
 
   CLI.out(
     CLI.bubble(
-      game.turn === '1' ? 'wh' : 'bh',
+      game.turn === 1 ? 'w' : 'b',
       String(game.move + 1) + '. ' + suggestion.pick.move,
     ),
   )

package/src/cmds/view.js

@@ -49,5 +49,5 @@ viewCmd.fn = (CLI, move) => {
       CLI.color(' vs ') +
       CLI.bubble('b' + (trax.turn === 2 ? 'h' : ''), players[1]),
   )
-  CLI.display(trax, players, false, show)
+  CLI.display(trax, players, undefined, show)
 }

package/src/puzzles.js

@@ -4,10 +4,20 @@
  * @license Apache-2.0
  */
 
+/** @type string[] */
+export const levels = [
+  'tutorial',
+  'beginner',
+  'tough',
+  'advanced',
+  'expert',
+  'master',
+]
+
 /** @type {{[key: string]: PuzzleSource}} */
 export const sources = {
   sbb: {
-    name: 'puzzlebot',
+    name: "slugbugblue's puzzlebot",
   },
   traxgame: {
     name: 'Donald G. Bailey',
@@ -25,8 +35,8 @@ export const puzzles = [
     icon: 'fd',
     player: 1,
     max: 3,
-    level: 1,
-    title: 'Tutorial: Loop attack',
+    level: 0,
+    title: 'Loop attack',
     desc: "You're playing white, so when you form a white loop, you win the game.",
     hints: ['A0/', 'B0\\'],
   },
@@ -38,8 +48,8 @@ export const puzzles = [
     icon: 'def',
     player: 2,
     max: 4,
-    level: 1,
-    title: 'Tutorial: Wide loop attack',
+    level: 0,
+    title: 'Wide loop attack',
     desc: "Your loop doesn't have to be a perfect circle, and it can be oriented in any direction.",
     hint: 'B2+',
   },
@@ -51,10 +61,10 @@ export const puzzles = [
     icon: 'ca:0e:0d',
     player: 1,
     max: 5,
-    level: 1,
+    level: 0,
     title: 'Partially formed wide loop',
     desc: "It doesn't matter which direction the loops are facing.",
-    hint: 'A2+',
+    hints: ['A2+', 'A3\\'],
   },
   {
     id: 'tutorial.04',
@@ -64,7 +74,7 @@ export const puzzles = [
     icon: 'd:aeec',
     player: 2,
     max: 6,
-    level: 1,
+    level: 0,
     title: 'Using a hollow',
     desc: 'You can use forced tiles with an inside corner to stretch your attack.',
     hint: 'C1+',
@@ -77,7 +87,7 @@ export const puzzles = [
     icon: 'ca:0ef:0ec:0d',
     player: 1,
     max: 7,
-    level: 1,
+    level: 0,
     title: 'Diverted attack',
     desc: "Even though black is attacking into this area, it doesn't stop you from completing your loop.",
     hint: 'A3+',
@@ -90,7 +100,7 @@ export const puzzles = [
     icon: 'd2f:aeeec',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Long cave',
     desc: 'Stretch the line with forced tiles.',
     hint: 'C1+',
@@ -103,7 +113,7 @@ export const puzzles = [
     icon: 'ae:0f:0a',
     player: 1,
     max: 7,
-    level: 1,
+    level: 0,
     title: 'Introduction to the L',
     desc: 'Use an L to form two attacks at once.',
     hint: 'A3/',
@@ -116,7 +126,7 @@ export const puzzles = [
     icon: 'f:bae:1f',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Mirrored Ls',
     desc: "This mirrored position gives an L to both players, but since it's your turn, you have the initiative.",
     hint: 'A3/',
@@ -129,7 +139,7 @@ export const puzzles = [
     icon: 'a:efae',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Sideways L',
     desc: 'An L can be in any orientation.',
     hint: 'D1+',
@@ -142,7 +152,7 @@ export const puzzles = [
     icon: 'fae:1ef',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Ls come in many shapes',
     hint: 'A2/',
   },
@@ -150,13 +160,13 @@ export const puzzles = [
     id: 'tutorial.11',
     src: 'sbb',
     game: 'trax',
-    notation: '@0+ @1\\ @1\\ D1+ D2\\',
+    notation: '@0+ B1/ C1/ @1+ A2/',
     icon: 'faee:2f',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Another L',
-    hint: 'A2/',
+    hint: 'D2\\',
   },
   {
     id: 'tutorial.12',
@@ -166,7 +176,7 @@ export const puzzles = [
     icon: 'ae:fd:0ae',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Fat L',
     desc: "Even though this looks a bit odd, it's just another L.",
     hint: 'C1/',
@@ -179,7 +189,7 @@ export const puzzles = [
     icon: 'bbae:2f',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Connectable pair L',
     desc: 'This L uses a connectable pair instead of two corners, but it works the same as the other Ls.',
     hints: ['A2\\', 'B2/'],
@@ -188,14 +198,14 @@ export const puzzles = [
     id: 'tutorial.14',
     src: 'sbb',
     game: 'trax',
-    notation: '@0+ @1\\ @1\\ C2+ C3+',
+    notation: '@0+ @1/ @1/ C0+ C0+',
     icon: 'fae:1e:1e',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Another connectable pair L',
     desc: 'There is a lot of variation in how Ls look, but being able to recognize them and activate them is key.',
-    hint: 'A2/',
+    hint: 'A2\\',
   },
   {
     id: 'tutorial.15',
@@ -205,7 +215,7 @@ export const puzzles = [
     icon: 'e:e:d:ae',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Simple connectable pair L',
     desc: 'Starting to get the hang of this?',
     hints: ['B1\\', 'B2/'],
@@ -218,7 +228,7 @@ export const puzzles = [
     icon: 'a:e:eec',
     player: 2,
     max: 8,
-    level: 1,
+    level: 0,
     title: 'Strange L',
     desc: 'Just another connectable pair L.',
     hint: 'B1/',
@@ -430,7 +440,7 @@ export const puzzles = [
     level: 2,
     player: 1,
     max: 11,
-    hint: 'A0/',
+    hints: ['A0/', 'C4\\', 'D5/'],
   },
   {
     id: 'iw3.trx',
@@ -441,7 +451,7 @@ export const puzzles = [
     level: 2,
     player: 1,
     max: 11,
-    hint: 'B0/',
+    hints: ['B0/', 'C0\\'],
   },
   {
     id: 'iw4.trx',
@@ -452,7 +462,7 @@ export const puzzles = [
     level: 2,
     player: 1,
     max: 11,
-    hint: '@2/',
+    hints: ['@2/', 'C0/'],
   },
   {
     id: 'iw5.trx',
@@ -485,7 +495,7 @@ export const puzzles = [
     level: 2,
     player: 1,
     max: 13,
-    hint: 'A1+',
+    hints: ['A1+', 'D1/'],
   },
   {
     id: 'ib1.trx',
@@ -507,7 +517,7 @@ export const puzzles = [
     level: 2,
     player: 2,
     max: 12,
-    hint: 'A1\\',
+    hints: ['A1\\', 'E1/'],
   },
   {
     id: 'ib3.trx',
@@ -529,7 +539,7 @@ export const puzzles = [
     level: 2,
     player: 2,
     max: 12,
-    hint: 'B0/',
+    hints: ['B0/', 'C0+'],
   },
   {
     id: 'ib5.trx',
@@ -562,7 +572,7 @@ export const puzzles = [
     level: 2,
     player: 2,
     max: 10,
-    hint: 'A0/',
+    hints: ['A0/', 'D3/'],
   },
   {
     id: 'ib8.trx',
@@ -638,8 +648,8 @@ export const puzzles = [
     icon: '0ca:deef:0d',
     level: 2,
     player: 1,
-    max: 13,
-    hint: 'B0/',
+    max: 15,
+    hints: ['B0/', 'C0\\'],
   },
   {
     id: 'hw4.trx',
@@ -737,8 +747,8 @@ export const puzzles = [
     icon: 'd:b:ba:aeecd:0fdec',
     level: 1,
     player: 2,
-    max: 16,
-    hint: 'B1+',
+    max: 18,
+    hints: ['B1+', 'B2/', 'D3+'],
   },
   {
     id: 'hb3.trx',
@@ -757,7 +767,7 @@ export const puzzles = [
     game: 'traxloop',
     notation: '@0+ A0/ A0/ A4/ A5+ @5/ @5/ @5+ A4/ @5/',
     icon: '3d:3c:3e:0d1d:cbdcb',
-    level: 2,
+    level: 3,
     player: 1,
     max: 15,
     hint: 'D1\\',
@@ -768,7 +778,7 @@ export const puzzles = [
     game: 'traxloop',
     notation: '@0+ B1/ C1+ C0/ D1\\ E1\\ F1+ E0/ F1/',
     icon: '2cdc:1dfae:ecb',
-    level: 2,
+    level: 3,
     player: 2,
     max: 16,
     hint: 'F0/',
@@ -779,7 +789,7 @@ export const puzzles = [
     game: 'traxloop',
     notation: '@0/ @1+ A0/ A0/ B2+ @2\\ @2\\ E3\\ E4+',
     icon: '1ca:afde:1bdf:3b',
-    level: 2,
+    level: 3,
     player: 2,
     max: 16,
     hint: 'A1\\',
@@ -790,9 +800,13 @@ export const puzzles = [
     game: 'traxloop',
     notation: '@0/ B1+ C1/ C0/ C0\\ @3/ C1+ E2/ F2\\',
     icon: '1baf:1cdca:cdecd',
-    level: 2,
+    level: 3,
     player: 2,
     max: 16,
     hint: 'B1+',
   },
 ]
+
+puzzles.sort(
+  (a, b) => a.level - b.level || a.max - b.max || (a.id < b.id ? -1 : 1),
+)