Velvet Pool

1. Overview

• 8-ball rules with fouls, ball-in-hand and solids/stripes
• Easy, Medium and Hard CPU opponents
• Practice table with undo, ball placement and re-rack
• Two players on the same device
• Cue-ball spin, five cloth colors and five cue styles
• Local achievements, statistics and personal scores

Vanilla JavaScript + WebGL2
English, Portuguese, Spanish

2. Quick installation

1. Extract the complete ZIP. The game/ folder is already ready to publish.
2. Upload the contents of game/ to a directory on your HTTP(S) host. Preserve all relative paths.
3. Open the index.html URL. Do not open via file://. No PHP, database or service account is required.

For a local test, open a terminal inside game/ and run:

python -m http.server 8765

http://localhost:8765/

3. Requirements and audio

Use a modern browser with JavaScript, ES modules and WebGL2. Enable hardware acceleration for 3D games. The first user gesture unlocks audio; browsers may block autoplay. Use HTTPS for public hosting. In an iframe, allow fullscreen and autoplay when needed.

4. Controls

Move the mouse to aim, click to lock the line, then drag down and release to shoot. Right-click releases the aim; the mouse wheel fine-tunes it. On touch, aim on the table and pull the power control. The Spin button controls follow, draw and side spin.

5. Interface layout guide

6. File map

Paths below are relative to source/. game/ contains deployable files; documentation/ contains these manuals and images; licenses/ preserves third-party notices.

7. Customization

Edit cloth and cue definitions in progress.js. Keep stable IDs for saved cosmetics. Tune CPU decisions in ai.js and physical parameters in physics.js independently; verify the 8-ball tests after changing rules or physics. Replace branding in assets/logo/ and adjust the matching dimensions in CSS.

Back up before editing. Change one feature at a time and test menu, gameplay, pause, result and reload. Keep item IDs and save keys stable to preserve existing players.

8. Optional developer workflow

This edition uses static JavaScript modules. No build or npm install is required. Edit source/ and copy changed files to game/. Preserve relative paths and included dependencies.

Optional automated checks: with Node.js 24 LTS, open a terminal inside source/ and run npm test (equivalent to node tests/run.js). No dependency installation is required. The suite checks physics, 8-ball rules, CPU matches and translation-key consistency. It does not replace browser/device/audio testing.

9. Saves and local records

Completed eligible CPU matches save a personal score locally. Practice and same-device matches do not submit ranking records. Match statistics and cosmetics remain on this browser. Changing the nickname does not create an online account.

Storage belongs to the browser origin (protocol, host and port). Changing domains does not transfer saves. Clearing data or private browsing can remove progress. Back up storage before migrating. This edition uses its own keys, separate from portal editions.

10. Dependencies, licenses and deployment

All required runtime assets are included, including fonts, audio and the libraries used. No mandatory CDN is used. This does not mean automatic PWA/offline installation: a fresh page load still needs access to your HTTP host. Multiplayer servers, online leaderboards, ad SDKs, native projects and internal editors are excluded. Use included assets as part of the licensed end product under the marketplace terms; do not resell them separately. Preserve full notices in licenses/ and font/vendor directories.

11. Troubleshooting and FAQ

Tela vazia / blank screen

Confirme HTTP(S), WebGL e caminhos com maiúsculas/minúsculas. Leia o console. / Check HTTP(S), WebGL, case-sensitive paths and browser console.

JS recusado / module refused

O servidor deve enviar .js e .mjs com MIME JavaScript; .wasm com application/wasm. Não use text/plain para módulos. / Serve .js and .mjs with JavaScript MIME, and .wasm as application/wasm.

Sem áudio / no audio

Toque no jogo, verifique volume e permissões do navegador. / Tap the game, check volume and browser permissions.

Save desapareceu / save lost

Confira domínio, porta, modo privado e limpeza de dados. / Check domain, port, private mode and storage clearing.

Posso adicionar multiplayer? / add multiplayer?

Requer desenvolvimento e servidor próprios; não é um recurso incluído. / Requires your own development and server; not included.

Funcionará em qualquer celular? / any phone?

Os controles se adaptam à tela. O desempenho depende do navegador e hardware; teste seus aparelhos alvo. / Controls adapt to screen size; performance depends on browser and hardware. Test your target devices.

12. Support and updates

Support and custom development: willian@polargames.com.br. Include version, URL, browser, reproduction steps and a screenshot. Support follows the marketplace item terms. Updates are distributed through your purchase channel; read the changelog before replacing files and preserve saves. This guide does not promise a fixed response time or new features on specific dates.