https://github.com/rbtying/shengji
An online version of shengji (a.k.a. tractor) and zhaopengyou (a.k.a. Finding Friends)
https://github.com/rbtying/shengji
card-games finding-friends shengji tractor zhaopengyou
Last synced: 5 months ago
JSON representation
An online version of shengji (a.k.a. tractor) and zhaopengyou (a.k.a. Finding Friends)
- Host: GitHub
- URL: https://github.com/rbtying/shengji
- Owner: rbtying
- License: mit
- Created: 2020-03-27T06:53:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-09-13T00:27:35.000Z (9 months ago)
- Last Synced: 2025-09-13T01:09:18.944Z (9 months ago)
- Topics: card-games, finding-friends, shengji, tractor, zhaopengyou
- Language: TypeScript
- Homepage: https://robertying.com/shengji/
- Size: 3.56 MB
- Stars: 93
- Watchers: 7
- Forks: 47
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# What is this?
升级 is a popular Chinese trick-taking playing card game, also known as tractor, finding friends, fighting for 100 points, 80 points, etc. Rules are available
[here](https://robertying.com/shengji/rules.html). Due to the COVID-19
shelter-in-place, I've been unable to play the this game in person... so
I figured an online version would be worthwhile.
# Usage:
```
cd frontend && yarn build && cd .. && cd backend && cargo run
```
The server is a self-contained static binary and does not terminate TLS. It
listens on 127.0.0.1:3030, and should only be exposed to an external network
behind a proxy that supports both HTTP and WebSocket protocols (only tested
with `nginx`).
## Environment Variables
- `CORS_ALLOWED_ORIGINS`: Comma-separated list of allowed origins for CORS requests to the `/api/rpc` endpoint (e.g., `"https://example.com,https://app.example.com"`). Set to `"*"` to allow any origin (not recommended for production). If not set, defaults to allowing common localhost origins for development (`http://localhost:3000,http://localhost:3030,http://127.0.0.1:3000,http://127.0.0.1:3030`).
# Development
```
cd frontend && yarn watch
cd backend && cargo run --features dynamic
```
## Syncing types from Rust to Typescript
There are shared types in the Rust backend and the Typescript frontend; the `frontend/json-schema-bin/src/main.rs` file dumps the Rust types to JSON Schema, and the `yarn types` command will generate the Typescript types.
```
yarn types && yarn prettier --write && yarn lint --fix
```
## Generating JSON
A mapping of card data is generated from the server. It's checked in at
`src/generated/cards.json`. To update it, start up the server and run
```
yarn download-cards-json
```
## Prettier
To format frontend code:
```
# Dry-run/check
yarn prettier --check
# Fix files, will overwrite files
yarn prettier --write
```
## Lint
To run tslint:
```
cd frontend && yarn lint
```
And clippy:
```
cargo clippy
```
## Tests
To run tests:
### Frontend:
```
cd frontend && yarn test
```
### Backend:
```
cargo test
```
# Technical details
The entire state of each game is stored in the memory of the server process.
Restarting the game kicks all players, and games are automatically closed when
all players have disconnected. The bulk of the game logic is implemented in the
server, but players are expected to keep each other in check -- the server does
not validate moves in their entirety.
For simplicity, the game is written in Rust and Javascript, linking in Axum as
the WebSocket/HTTP server implementation and using React from a CDN.
# Known issues
- No mobile support
- Incomplete validity checking for forced-plays
- No player limit per game
- No overall player limit
# Play online!
[https://robertying.com/shengji/](https://robertying.com/shengji/)