KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #claude-code #codex #cli #agent-skills #ai #dsh-plugin #mcp #windows #agent

fen-tool

★ 15 Open GitHub ↗

Quick online tool for chess with features for composing problems and APIs.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FEN-Tool

This is a quick online tool for editing FEN (Forsyth-Edwards Notation) in chess,
specifically designed with the needs of the chess composition community in mind.

## 💡 How to use

Simply drag-and-drop pieces from the template to arrange them on the board,
or manually input FFEN syntax (see below) by double-clicking on the squares.
Options and tools should be mostly self-explanatory.

You can also install FEN Tool as a standalone app on your device!
Just visit the site using Chrome (on devices other than iPhone), Edge (on desktops), or Safari (on an iPhone),
and use the "Install application" (or "Add to home screen") function in your browser to install it.

<br>

## ♟️ Notation

This tool supports all the [Fairy FEN](https://www.janko.at/Retros/d.htm) syntax (by Joost de Heer). A brief summary:

- Use `-` in front to denote neutral pieces (e.g. `-k`).
- Use `*` + number to denote rotation (e.g. `*2Q`). May be used together with neutral piece (e.g. `-*3b`).
  **Tip: On desktops, use mouse wheel on the pieces to rotate them directly. For mobile devices, do a small rotation finger gesture instead.**
- Use `'` + single char or `''`(that's two single-quote, not a double-quote) + double chars to denote text (e.g. `'A`, `''12`). May be used together with rotation (e.g. `*1'A`).\
  Note that you can even use emoji with this syntax (e.g. `'🦆` or `'👨‍👩‍👧‍👦`; composite emoji characters will be recognize as one).  \
  It is worth mentioning that, with the FFEN syntax, it is not possible to type the character `'` itself.\
  **Tip: You can directly input text of 1 or 2 chars into a square, and it will be automatically converted to FFEN syntax if it doesn't match existing syntax.**
- Four markers defined in FFEN can be used: `c` (circle), `x` (cross), `s` (square) and `t` (triangle).\
  Note that if "use S for knight" option is on, to avoid ambiguity, we will use `g` (from the German word "geviert") for the square marker instead.\
  We also support two additional markers: `a` (asterisk) and `d` (dame).
- Custom board dimension syntax is supported. For example, `4/4/4/4` represents an empty 4 x 4 board.

You can also put in the fairy notation used by [YACPDB](https://www.yacpdb.org/), for example `(!b2)` means the same as `-*2b`.

<br>

## 🛠️ Additional tools

### Popeye

This tool integrates [Popeye](https://github.com/thomas-maeder/popeye),
one of the most powerful and popular chess problem solvers.
Just put the problem description in the input box
(Forsyth notation of the current board will be added automatically if not given) and press `Run`!
See [Popeye documentation](https://github.com/thomas-maeder/popeye/blob/master/py-engl.txt) for more.
After the computation completes, you can also playback solutions.

Tips:
1. Imitators are represented by neutral circle (`-c`) by default.
If you have those on the board, it will automatically add the corresponding `condition` command to your input.
2. You can use left/right keys (or A/D keys) to quickly navigate move history.

Thanks to [Dmitri Turevski](https://github.com/dturevski) for sharing his insights in Popeye.

### Stockfish

This tool integrates [Stockfish.js](https://github.com/nmrugg/stockfish.js)
based on the latest version (v16) of [Stockfish](https://github.com/official-stockfish/Stockfish),
one of the strongest orthodox chess engines. Due to its model size,
Stockfish modules are not pre-downloaded upon first visit,
but once it's downloaded it will be cached for good.

When "Study mode" is enabled, it will treat the position as a study problem,
and try to find the longest unique solution sequence against best defenses.

### Syzygy

Utilizing [Syzygy API](https://github.com/lichess-org/lila-tablebase),
FEN Tool is able to completely determine all studies with up to 7 pieces.
Like the Stockfish study mode, it will also continue to search for White's unique
responses against Black's "best" defenses.

### Play mode

This tool allows you to play on the setup board and record moves.
Only orthodox chess is supported.
There are three different modes:

1. Normal: can be used in direct mates and helpmate problems.
2. Allow passing moves: can be used in for example series helpmate problems.
3. Retro: playing backwards, used in retrograde analysis problems.

### PDB

You can fetch a PDB problem by using its ID number,
or search for a problem using the position (fairy pieces are not supported in search).
It can also generate PDB board edit syntax (with fairy piece support)
that can be used when adding or editing a problem in PDB.

### YACPDB

This is similar to the PDB tool, with the addition of copying YACPDB style FEN.
Note that rotation is not supported in board edit syntax.

### BBS

This tool is for Taiwan BBS forums such as PTT, so it is shown only in Taiwan.
It generates colored BBS text (with traditional Chinese annotations)
that can be paste directly into posts.

<br>

## 🖼️ Sharing image

There are several ways you can share images generated by this tool:

- On mobile devices, you can use the `Share image` button to quickly share to other apps.\
  Note: Firefox Android does not support sharing image directly,
  and in that case it will fallback to sharing image URL instead.
- On desktops, you can copy the image using the `Copy image` button, and paste into other apps.
- You can also generate a URL that represents the image using `Create image URL` button.\
  This service currently is provided by [imgBB](https://imgbb.com/).

<br>

## 🖥️ API

To add generated images to your webpages, you can of course use the `Create image URL` button.
However, there are several downsides to this approach:
1. Each image will contribute to extra download traffic when visitors visit your website,
   giving them a slower browsing experience.
2. As the generated URLs are based on a third-party service,
   there's no guarantee that those will last forever.
3. This can only generate a fixed image that does not adapt itself to the user device's
   pixel ratio or font settings.

A more recommended approach is by using one of our APIs.
This tool uses service worker to cache all assets,
so once the user has loaded an instance, our APIs will run very fast,
and there won't be any additional traffic for the visitors.
And since this tool is hosted on GitHub pages, it will likely last
much longer than most other services. Plus the generated image will
automatically adapt to the device pixel ratio and font for the best quality.
Finally, the generated image will be updated together with the tool,
should the tool made any improvements in the image quality.

We provide two different modes.

### Embed mode

If you just want to quickly add one or two images to your page, embed mode is for you.
You can use it by adding an `<iframe>` to your page like this:
```html
<iframe src="https://mutsuntsai.github.io/fen-tool/gen/?fen=rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR" style="border:none;width:354px;height:354px"></iframe>
```
The code may be generated by the `Copy embed HTML code` button.

### SDK mode

If you need to add a lot of images to your site,
don't want to use `<iframe>` for whatever reasons,
or you might need to dynamically change the image,
the SDK mode is for you. To use it,
first add our SDK script to your webpage like this:

```html
<script src="https://mutsuntsai.github.io/fen-tool/sdk.js"
	data-size="26" data-set="alpha" data-bg="gray"></script>
```

This can be put anywhere, but preferably in the `<head>` part. 
The `data-` attributes in this example gives you an idea of how to assign global board options.
You don't need to worry about the details,
as our `Copy SDK script tag` button will help you generate it based on your settings
(except for board pattern and custom dimensions, which are not included for practical reasons).

#### Board options

| Attribute | Description |
|---|---|
| `data-size` | Square size in pixels (default: 26) |
| `data-set` | Piece set name (e.g. `alpha`, `merida`) |
| `data-bg` | Background color (e.g. `gray`, `brown`) |
| `data-pattern` | Board pattern |
| `data-border` | Border style |
| `data-black-white` | Black and white mode (presence enables it) |
| `data-coordinates` | Show coordinates (presence enables it) |
| `data-sn` | Use S for knight (presence enables it) |

Then all you have to do is something like this:

```html
<img fen="rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR">
```

As long as `<img>` has the `fen` attribute on it, our SDK detects it and will automatically convert it to the actual image. You can also add `data-` attributes to the `<img>` to override global options, for example:

```html
<img fen="rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR"
	data-size="32" data-pattern="inverted">
```

One cool thing about the SDK mode is that it allows you to control the image dynamically using JavaScript. For example:

```js
const img = document.getElementById("myImg");
img.setAttribute("fen", "8/8/8/8/8/8/8/8"); // Assign a new FEN
img.dataset.size = 38; // Change option
```

And the image will update automatically. You can also dynamically add or remove `<img>` elements, and it just works.

The internal mechanism used in our SDK is compatible with most front-end frameworks as well. For example, with [Vue.js](https://vuejs.org/) you can do this:

```html
<img v-if="shouldShowBoard" :fen="myFEN" :data-size="mySize">
```

<br>

## 🖥️ Popeye Playback API (Experimental)

If you want to embed interactive Popeye solution playback on your webpage,
you can use our Popeye Playback API. It provides two Web Components:
`<popeye-board>` for the chess board, and `<popeye-solution>` for the interactive solution panel.
They are designed as two separate elements so that you have full control over their layout and positioning,
and you can use CSS to customize the size and appearance of each component independently.

### Quick start

First, add the script to your page:

```html

<script src="https://mutsuntsai.github.io/fen-tool/popeye.js"
    data-size="26" data-set="alpha"></script>
```

Then use the two components together:

```html

<popeye-board id="demo" data-bg="gray"></popeye-board>
<popeye-solution for="demo">
    <script type="text/plain" data-input>
        pieces white kf5 qd1
        pieces black ke8
        stipulation #2
        opti vari
    </script>
    <script type="text/plain" data-output>
        1.Kf5-f6 ! zugzwang.
            1...Ke8-f8
                2.Qd1-d8 #
    </script>
</popeye-solution>
```

### Copy API tags

In the main app's Popeye tool panel, after running a solution, you can use the `Copy API tags` button
to copy ready-to-use HTML code for `<popeye-board>` and `<popeye-solution>` to your clipboard.
The generated code includes your current board settings and piece mappings,
so you can paste it directly into your webpage.

### `<popeye-board>`

This component renders the chess board canvas.
It supports the same `data-` board options as the SDK mode (see [Board options](#board-options) above).
These can be set globally on the `<script>` tag or locally on each `<popeye-board>` element.

### `<popeye-solution>`

This component parses and renders the Popeye output as interactive, clickable steps.
Use the `for` attribute to link it to a `<popeye-board>` by its `id`.

It expects two `<script type="text/plain">` children:

- `<script type="text/plain" data-input>`: the Popeye input (problem description).
- `<script type="text/plain" data-output>`: the raw Popeye output (solution text).

Using `<script type="text/plain">` instead of `<template>` ensures that whitespace indentation
(which is significant for Popeye output) is preserved by HTML formatters.

#### Attributes

| Attribute | Description |
|---|---|
| `for` | **Required.** The `id` of the linked `<popeye-board>`. |
| `data-piece-map` | Custom fairy piece mapping, as comma-separated `KEY=VALUE` pairs (e.g. `*2Q=G,C=I`). |

#### Navigation

The `<popeye-board>` component includes navigation buttons (first, previous, next, last) below the board.
When the solution panel is focused, you can also use keyboard shortcuts:

| Key | Action |
|---|---|
| Left / Up | Previous step |
| Right / Down | Next step |
| Home | First step |
| End | Last step |

<br>

## ⚜️ Chess set credits

- `1Echecs` is designed by Christian Poisson.
- `Alpha` is designed by Eric Bentzen.
- `Good Companion` is designed by David L. Brown.
- `Kilfiger` is designed by James Kilfiger [The Difficult Type](http://james.kilfiger.googlepages.com/).\
  The original font name is just "Chess". Slightly modified for this app.
- `Merida` is designed by Armando Hernandez Marroquin.
- [`MPChess`](https://github.com/chupinmaxime/mpchess) is designed by Maxime Chupin. Slightly modified for this app.
- [`Skak`](https://github.com/lehoff/skak) is designed by Piet Tutelaers and modified by Torben Hoffmann.

## Build instructions

To build and run this project, you will need the following:
- [Node.js](https://nodejs.org/)
- [PNPM](https://pnpm.io/) (recommended over NPM), and then execute the following in the project folder: `pnpm install`.

Then you can run the project by the following:

```bash
pnpm start
```

This will build the project and start the development server.

To build and start the release server, run the following:

```bash
pnpm build
pnpm preview
```

fen-tool

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README