POLAR GAMES · VERSION 1.0.0

Sunset Rally

1. Overview

Three.js + TypeScript + Vite
English, Brazilian Portuguese

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 pointer or drag to control your paddle. Follow the on-screen serve prompt and return the ball over the net. Assist can be toggled in play. Use the pause button for resume, restart and menu. Gameplay and display options are in Settings.

5. Interface layout guide

Main menu: modes and navigation
Main menu: modes and navigation
Actual gameplay: play area and HUD
Actual gameplay: play area and HUD
Settings: language, sound and game options
Settings: language, sound and game options

6. File map

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

FilePurpose
src/game/Campaign.tsNine-match campaign and star conditions
src/game/Places.tsThree locations and their appearance
src/game/Game.tsMatch flow, local saves and menus
src/sim/physics.tsBall motion and collisions
src/sim/match.tsScoring and match rules
src/i18n.tsEN/PT interface strings
src/styles.cssInterface styling
public/audio/Self-hosted sound files
public/fonts/Local fonts and full OFL notices
vite.config.tsPortable relative-path build

7. Customization

Adjust campaign matches and their star conditions in Campaign.ts. Change location appearance in Places.ts and visual definitions used by Game.ts. Preserve unlock identifiers in existing saves. Tune physics separately from display settings, then test serves, net collisions, out balls, rally scoring and match completion.

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

Node 24 LTS recommended. Inside source/:

npm ci
npm run typecheck
npm run build

Publish only the contents of dist/. preview serves the local build for inspection. Do not upload node_modules/. Vite uses a relative base for subdirectories. The delivered runtime is formatted for readability; retain minify:false and cssMinify:false when rebuilding.

9. Saves and local records

This game already stores campaign stars, results and statistics locally. No additional global leaderboard or PHP backend is included. The pause menu and replay remain available in solo matches.

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.