@slugbugblue/trax 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,13 +1,30 @@
 # @slugbugblue/trax
 
-## 0.3.0
+## 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
+## 0.2.0 - 2021-12-28
 
 Breaking changes:
 
@@ -21,7 +38,7 @@ More convenience:
 * `Trax.player_num[color]`: or from color to player number
 * `Trax.other[color]`: easily switch from 'w' to 'b' and back
 
-## 0.1.0
+## 0.1.0 - 2021-12-26
 
 Initial release:
 

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
@@ -49,7 +53,6 @@ until I get around to documenting the functionality.
 ## Roadmap
 
 * Documentation
-* Test suite
 * Command line interface
 * Bot for solo games (?)
 * Puzzles
@@ -94,7 +97,7 @@ 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

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.