Skip to content

docs: add section for stockfishts #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jalpp wants to merge 2 commits into from
+4 −0
Closed

docs: add section for stockfishts #118

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98d325f
docs: add usage instructions for stockfish.js in React.js
jalpp Jul 12, 2026
420b695
docs: link formatting for @jalpp/stockfishts library
jalpp Jul 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ Stockfish.js is simply a raw engine. You'll need to bring the rest of the parts

To learn how to use the engine in your own projects, see the <a href="https://github.com/nmrugg/stockfish.js/tree/master/examples">examples folder</a>. In particular, see `examples/loadEngine.js` for a sample implementation of how to load and run engines.

### How do I use stockfish.js in React.js or in web applications?

You can explore [@jalpp/stockfishts library](https://www.npmjs.com/package/@jalpp/stockfishts), it is a TypeScript library for running Stockfish engines from both frontend and backend projects. It supports WebAssembly-based engines, worker-based execution, and a small, ergonomic API for evaluating chess positions and receiving incremental updates from stockfish.js wasm engine files.

### How do I compile the engine?

You only need to compile the engine if you want to make changes to the engine itself.
Expand Down