About The Project

Built With

• Typescript
• ESLint
• Prettier
• Husky

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/LionelKarlen/Scrapple-Lib.git

2. Install packages

   yarn

3. Run linter to ensure everything is set up

   yarn lint

Usage

Example usage to run a game of Scrapple.

const s: Scrapple = new Scrapple(2, 'en'); // Initialise new game
// Check fields
console.log(s.board);
console.log(s.bag);
console.log(s.players);
console.log(s.bag.length);

// Define a move
const move: Move = {
	movePieces: [
		{
			index: 0,
			piece: s.players[0].bench[0],
			toCoordinate: {
				x: 7,
				y: 7,
				index: 112,
			},
		},
	],
	player: s.players[0],
};

// Make the move
s.makeMove(move);

For more examples and full explanations, please refer to the Documentation

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Acknowledgments

• Readme Template
• Scrabble Rules and guide

This project is designed entirely for educational use. I have no association to the Scrabble name, connected brands, nor do I profit from this project. No copyright infringement is intended. If you represent any copyright holders of the affected parties, please contact me so that we can work out how to continue.