backgammon.js-lib

The backgammon.js-lib library, used by both backgammon.js-client and backgammon.js-server, provides the following functionality:

Object oriented model of classes modeling real-world and objects and abstract notions (model.js file);
Message IDs shared by client and server communication objects (comm.js file);
Base Rule class describing a variant of the game (rules/rule.js file);
Sample rules for three variants of the game: rules/RuleBgCasual.js, rules/RuleBgGulbara.js and rules/RuleBgTapa.js.

The whole picture

To get an idea how the library package fits in the whole picture, look at project README and detailed documentation.

Check out library reference and class diagrams in documentation for more details on available classes.

To recompile library reference, using jsdoc, execute the following:

cd lib
npm run build:docs