@slugbugblue/trax 0.2.0 → 0.5.0

package/CHANGELOG.md

@@ -0,0 +1,51 @@
+# @slugbugblue/trax
+
+## 0.4.0 - 2022-01-17
+
+* Testing coverage of `engine.js` is now at 100%
+* Testing revealed a few bugs, which are now fixed
+* The name and signature for provisional move handling,
+  which was broken, has been changed. It is now called
+  `provisional_moves()` and takes three arguments:
+
+  * `from`: the normalized position code of the board before the move
+  * `to`: the normalized position code of the board after the move
+  * `via`: the move notation to go from `from` to `to`
+
+### 0.3.1 - 2022-01-07
+
+* Make a faster implementation of `trax.possible_locations()`
+* Display updates for tentative moves
+
+## 0.3.0 - 2021-12-29
+
+Display a tentative move on the screen
+
+* Add `trax.tentative_icon()` function
+* `tty.display()` now accepts a tentative move
+
+## 0.2.0 - 2021-12-28
+
+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 - 2021-12-26
+
+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

@@ -14,6 +14,10 @@ is to allow Trax to be played programmatically.
 It can be used as an engine in a web browser
 or in nodejs.
 
+The Trax engine now enjoys automated testing
+with 100% code coverage. Any future changes
+to the engine should meet the same standard.
+
 ## Installation
 
 ```bash
@@ -26,11 +30,21 @@ 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'
 
+// default constructor gives you a Trax game
 let trax = new Trax()
-
 trax.play('@0/')
+
+// but you can also select Loop Trax
+let loops = new Trax('traxloop')
+
+// or 8x8 Trax
+let tiny = new Trax('trax8')
+
+// and the constructor lets you start with an initial set of moves
+let puzzle = new Trax('trax', '@0/ a0\\ @2/')
+puzzle.play('@2\\')
 ```
 
 Explore the file `engine.js` for more information
@@ -39,7 +53,6 @@ until I get around to documenting the functionality.
 ## Roadmap
 
 * Documentation
-* Test suite
 * Command line interface
 * Bot for solo games (?)
 * Puzzles
@@ -48,7 +61,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,22 +79,25 @@ 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
 
-Copyright 2021 Chad Transtrum
+Copyright 2019-2022 Chad Transtrum
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use the files in this project
@@ -98,7 +114,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/docs/engine.md

@@ -0,0 +1,64 @@
+# engine.js API documentation
+
+This module provides the logic to handle interacting with a Trax game, including
+starting a game, making moves in the game, and determining if the game has been
+won.
+
+A few other functions/properties are also provided to assist with determining
+the game state and what actions can be taken on the game.
+
+## Example usage
+
+```javascript
+import Trax from '@slugbugblue/trax'
+
+let trax = new Trax()
+console.log(trax.possible_moves()) // "[ '@0/', '@0+' ]" -- initial moves
+
+trax.play('@0/')
+console.log(trax.turn) // "2" -- it is player 2's turn
+
+trax.play('@1\\')
+console.log(trax.color) // "w" -- it is white's turn
+
+trax.play('A0/')
+console.log(trax.over) // "true" -- the game is over
+console.log(trax.winner) // "1" -- player 1 wins
+```
+
+## API
+
+### Trax object
+
+The Trax object can be called as a constructor, but it also has the following
+class properties and methods:
+
+- `Trax.variants`: an array of the different rule sets the engine supports.
+
+- `Trax.column(col)`: a function to turn a numeric column number into the column
+  letter used in Trax notation.
+
+### Trax class
+
+#### constructor
+
+```javascript
+trax = new Trax(rules, moves, id)
+```
+
+- `rules
+
+## License
+
+Copyright 2019-2022 Chad Transtrum
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+the files in this project except in compliance with the License. You may obtain
+a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.