https://github.com/lichess-org/pgn-mule

Merge, filter, tweak and expose PGN sources
https://github.com/lichess-org/pgn-mule

Last synced: about 2 months ago
JSON representation

Merge, filter, tweak and expose PGN sources

• Host: GitHub
• URL: https://github.com/lichess-org/pgn-mule
• Owner: lichess-org
• License: agpl-3.0
• Created: 2020-07-10T13:06:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-18T14:31:00.000Z (7 months ago)
• Last Synced: 2024-06-18T17:54:31.457Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 452 KB
• Stars: 13
• Watchers: 10
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Merge, filter, tweak and expose PGN sources.

## Usage

```

# start redis

docker run -p 6379:6379 redis:latest

```

```

# edit .env

pnpm install

pnpm start

```

In zulip

```

add    

list

remove 

addMany 1,2,3,4,5,6,7 {} -{}.pgn  

addReplacement from->to

listReplacements

delReplacement 0

```

## Alternative sources

### Lichess game

Use `lichess:gameId1,gameId2` (and so on) as `` to poll Lichess games. This can only handle polling 30 games per second (fewer if faster, more if slower) at maximum, probably fewer for reasonable stability.

### LCC

Use `lcc:/` as ``.

### Chess.com

Use `chesscom:/` as ``.

## QueryString Options:

Note that the first option must start with `?`, and the later ones with `&`.

Examples:

- `url.com/foo?round=1`

- `url.com/foo?round=1&slice=1-20&shredder=1`

- `url.com/foo?slice=1-20&round=1`

In the examples below we'll only show `&`. Replace with `?` if it's the first option.

### shredder

For a given url, add in: `&shredder=1` which will convert X-Fen to Shredder-Fen

## Custom Round Tags

Add in: `&roundbase=1.{}` and the games will have their 1.{}

replaced with 1.1, 1.2, 1.3 ...

## Deploy

```sh

pnpm build; rsync -aLv build node_modules [email protected]:/home/zulip-pgn-mule/; ssh [email protected] "chown -R zulip-pgn-mule /home/zulip-pgn-mule/ && systemctl restart zulip-pgn-mule"

```