@bridge-tools/core is an open-source library written in Typescript. It is designed to simplify the process of writing bridge software. The types and functions provided form the fundamentals to allow a Typescript bridge platform to be built quickly, with less initial effort.
The idea of @bridge-tools/core came from libraries designed for other games, such as chess.js.
- Types for cards, bids, boards and more
- Conversion to and from strings
- Score calculation
- Functions for checking validity of auctions and cardplay
- Functions for evaluating tricks
- 100% unit test coverage
@bridge-tools/core is available on npm.
It can be installed via:
$ npm i @bridge-tools/coreThe components of the library can be imported as required.
For the full list of the different components, view the README inside ./src.
We would appreciate attribution, just a simple link back to this github, but we have not made it a requirement.
We're proud to have 100% test coverage. The unit tests can be run via the command:
$ npm testIf you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker or ask a question on the discord. To get in touch directly you can email us at aaron@bridge-tools.com.
To contribute either send us an email or join the discord. Contributions should follow the guidelines set out in CONTRIBUTING.
If you would like to support further development of the @bridge-tools suite you can buy us a coffee.
- @bridge-tools/generator - Used for hand generation using fast or cryptographically secure RNGs
-
@bridge-tools/lin- For conversion to and fromlinfiles -
@bridge-tools/pbn- For conversion to and frompbnfiles -
@bridge-tools/dds- A pure javascript double-dummy solver which can be run in a browser