Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhonnold/node-tlcv
Tom's Live Chess Viewer for CCRL Broadcasts on the web!
https://github.com/jhonnold/node-tlcv
ccrl chess chess-engine tlcv
Last synced: 20 days ago
JSON representation
Tom's Live Chess Viewer for CCRL Broadcasts on the web!
- Host: GitHub
- URL: https://github.com/jhonnold/node-tlcv
- Owner: jhonnold
- License: mit
- Created: 2021-08-10T12:21:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-08T14:46:38.000Z (25 days ago)
- Last Synced: 2024-12-08T15:31:36.092Z (25 days ago)
- Topics: ccrl, chess, chess-engine, tlcv
- Language: TypeScript
- Homepage: https://ccrl.live
- Size: 4.7 MB
- Stars: 24
- Watchers: 5
- Forks: 8
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Node TLCV
A server implementation of Tom's live chess viewer. Designed to work with Graham Bank's [CCRL](https://computerchess.org.uk/ccrl/4040/) broadcasts. Watch live at [https://ccrl.live](https://ccrl.live/)!
## Running your own
### Requirements
- Your own [Tom's live chess server](https://www.chessprogramming.org/TLCS-TLCV)
- I do not know how TLCS is setup as I do not host any broadcasts myself
- [Node.JS](https://nodejs.org/en/)
- [pm2](https://pm2.keymetrics.io/) if you'd like to run this in the background
### Setup
- Modify [config.ts](src/config.ts)
- `url` should be the **IP ADDRESS** of your chess server
- `ports` should be an array of the initial ports you'd like to connect to
- Create a `.env` file at the same level as this `README` and specify a `TLCV_PASSWORD`
```bash
# .env
TLCV_PASSWORD=password
```
### Compile
```bash
npm install && npm run build
```
### Start the server
- Launches on port 8080
```bash
node build/src/main.js # runs in foreground
# or
pm2 start build/src/main.js # runs in background
```
### Admin Panel
- Admin panel can be accessed at `/admin`
- Username is `admin`
- Password is specified by the `TLCV_PASSWORD` environment variable (see above)