Is billiards still maintained?

Yes, active. Last change today.

Can I trust billiards?

Some track record. 276 stars, 11 years old. Get it from the official repo and read what it installs.

gitmanual

Reading the repo

Opening the box…

Assembly instructions

tailuge/billiards

billiards physics in the browser

Node.js#3-cushion#3d#billiards#carom

Before you start

Is it free?: YesOpen source (GPL-3.0).
Still maintained?: Yes, activeLast change today.
Can I trust it?: Some track record276 stars, 11 years old. Get it from the official repo and read what it installs.

Difficulty: Easy
Time: about 5 min
Stars: ★ 276
Activity: Updated this month
Got it running: 1 person

Saved setup from just now

Will it work on macOS?

Yes, it runs on macOS

You'll build it yourself with Node.js.

Your system

macOS Windows Linux

Start here

Website ↗billiards.tailuge.workers.devThe project's own site.

5 steps on macOS

Download setup.sh

Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.

Clone the repository

Needs Git: xcode-select --install

git clone https://github.com/tailuge/billiards.git
cd billiards

Install the required runtimes

Node.js lts

# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm)
nvm install --lts

3
Install dependencies
```
corepack enable
yarn install
```
4
Run it
```
yarn dev
```
5
Run the tests
```
yarn test
```

From the README: Install

You dont, you just play in your browser at billiards.tailuge.workers.dev/lobby

If you prefer, you can install a thin client wrapper:

Windows / macOS / Linux — Download
Android — Driect Download or via APKPure or Obtainium

Did you get it running?

No reports for macOS yet.

Still stuck? Get a written guide

GitManual AI Agent reads the 4 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.

Parts list

1×Node.js ltsruntime
1×yarn yarn@4.9.1package manager

Share this manual

Is this your repo?

Add a badge to your README so newcomers find these steps.

[![Setup manual](https://gitmanual.com/tailuge/billiards/badge.svg)](https://gitmanual.com/tailuge/billiards)

Good to know

Has AGENTS.md — instructions for coding agents. You can open Claude Code (or another agent) in the cloned folder and ask it to do the setup for you.

Details

License: GPL-3.0
Open issues: 12
Branch: master

package.json scripts (19)

testjest --config ./test/jest.config.js --verbose --silent
coveragejest --config ./test/jest.config.js --coverage --silent
version-gennode -e "const d=new Date();const v=d.getFullYear().toString().slice(-2)+('0'+(d.getMonth()+1)).slice(-2)+('0'+d.getDate()).slice(-2)+'.'+('0'+d.getHours()).slice(-2);require('fs').writeFileSync('src/utils/version.ts', 'export const VERSION = \'' + v + '\';\n')"
sitemap:cfsed -i 's|tailuge\.github\.io/billiards$/dist$\?|billiards.tailuge.workers.dev|g' dist/sitemap.xml dist/robots.txt && sed -i '/xhtml:link/d' dist/sitemap.xml && sed -i -e 's|/index\.html</loc>|/</loc>|g' -e 's|\.html</loc>|</loc>|g' dist/sitemap.xml && sed -i "s|<lastmod>.*</lastmod>|<lastmod>$(date +%Y-%m-%d)</lastmod>|g" dist/sitemap.xml
devwebpack
buildnpm run version-gen && webpack
build:cfnpm run version-gen && webpack && npm run sitemap:cf
linttsc --noEmit && eslint .
lint:cssstylelint "dist/**/*.{css,html}"
lint:htmlhtml-validate -c test/.htmlvalidate.json $(find dist -name '*.html' ! -name 'yandex_*.html')
prettifyprettier --cache true --write --trailing-comma es5 --no-semi {src,test}/**/*.[jt]s dist/**/*.{css,html} *.[jt]s *.json
markdownlintnpx markdownlint-cli2 README.md --fix
serveconcurrently "npm run watch" "npm run start-server"
start-serverhttp-server dist -p 8080 -c-1
watchwebpack --watch
depsnpx yarn-check --skip-unused -i typescript
gltfpacknpx gltfpack -i dist/models/p8.gltf -o dist/models/p8.min.gltf && npx gltfpack -i dist/models/threecushion.gltf -o dist/models/threecushion.min.gltf && npx gltfpack -i dist/models/snooker.gltf -o dist/models/snooker.min.gltf
indexnownode test/indexnow.mjs
indexnow:testnode test/indexnow.mjs --test

Files we read (4)

.github/CONTRIBUTING.md

.github/workflows/main.yml

README.md

package.json

556 files in the repo

Yes, it runs on macOS

Start here

5 steps on macOS

Clone the repository

Install the required runtimes

Install dependencies

Run it

Run the tests

From the README: Install

Did you get it running?

Still stuck? Get a written guide

More like billiards that run on macOS