Polar GamesPolar Games

Beep Out documentation

Documentação Beep Out

Standalone 1.0.1 · HTML5 · Local browser records

Edição independente 1.0.1 · HTML5 · Recordes locais

Thank you for choosing Beep Out. This guide explains installation, play, customization, local data and troubleshooting. Start with the ready-to-upload game/ folder; source/ is optional.

Obrigado por escolher Beep Out. Este guia explica instalação, jogo, personalização, dados locais e soluções de problemas. Comece com game/ pronta para subir; source/ é opcional.

What this edition includes

O que esta edição inclui

A 30-level toy-traffic puzzle. Tap a vehicle whose directional exit is clear. From level 4, match vehicles with the passenger queue while managing limited parking spaces. Hints, undo, guided onboarding and Clean Clear goals support campaign progression.

Puzzle de trânsito com 30 fases. Toque num veículo cuja saída indicada esteja livre. A partir da fase 4, combine as cores dos veículos com a fila de passageiros e administre vagas limitadas. Dicas, desfazer, tutorial guiado e objetivos Clean Clear acompanham a campanha.

Standalone HTML5 • WebGL 2 • local browser data • readable runtime/source • no online services

HTML5 independente • WebGL 2 • dados locais • código legível • sem serviços online

Install in a few steps

Instalação em poucos passos

1. Extract the ZIP on your computer. 2. Open this manual. 3. Create a folder on your hosting, for example /games/beep-out/. 4. Upload every file and subfolder INSIDE game/ into it. 5. Open the HTTPS URL ending in index.html and click/tap to start. 6. Play, open settings and reload to check local progress.

1. Extraia o ZIP no computador. 2. Abra este manual. 3. Crie uma pasta na hospedagem, por exemplo /games/beep-out/. 4. Suba todos os arquivos e subpastas de DENTRO de game/. 5. Abra a URL HTTPS terminada em index.html e toque para iniciar. 6. Jogue, abra ajustes e recarregue para conferir o progresso local.

beep-out-static-1.0/
  START-HERE.txt
  game/                 <- upload these contents
    index.html
    beep-out.config.js
    assets/ or src/      <- keep all delivered folders
  documentation/        <- this EN/PT manual and labeled images
  source/               <- optional developer project, DO NOT UPLOAD
  THIRD-PARTY-LICENSES/

No Node.js process, PHP, database, publisher account, ranking server or advertising account is needed to play. Serve the game over HTTP/HTTPS; file:// is not supported.

Não precisa de processo Node.js, PHP, banco, conta do autor, servidor de ranking ou conta publicitária para jogar. Sirva o jogo por HTTP/HTTPS; file:// não é suportado.

<iframe src="https://your-site.example/games/beep-out/index.html?lang=en"
  width="100%" height="720" style="border:0"
  allow="autoplay; fullscreen" allowfullscreen title="Beep Out"></iframe>

Controls and game modes

Controles e modos

Click/tap a vehicle to attempt its indicated exit. Use the visible hint/undo/restart controls when available. Select levels from the campaign menu and use Settings for audio, language, motion and graphics.

Clique/toque num veículo para tentar a saída indicada. Use os controles de dica, desfazer e reinício quando disponíveis. Escolha fases no menu da campanha e use Ajustes para áudio, idioma, movimento e gráficos.

The campaign contains 30 levels. Completion, Clean Clear status and optional best-time records are stored per level in this browser. This edition has no global leaderboard, online mode, advertising SDK, PHP or database. Do not add a score server to install it.

A campanha tem 30 fases. Conclusão, Clean Clear e recordes opcionais de tempo ficam por fase neste navegador. Esta edição não tem ranking global, modo online, SDK de anúncios, PHP ou banco. Não é preciso adicionar servidor de pontuação.

Menu, gameplay and settings guide

Guia do menu, jogo e ajustes

Beep Out menu screen123
Main menu: start or continue, available game modes, language and settings. Labels reflect the selected language.
Menu: iniciar/continuar, modos disponíveis, idioma e ajustes. Os textos acompanham o idioma.
  1. Start / Continue the campaignIniciar / Continuar a campanha
  2. Level selection and garageSeleção de fases e garagem
  3. Open settingsAbrir ajustes
Beep Out gameplay screen1234
Gameplay layout: numbered markers explain the main controls and playfield below. The screenshot is an actual example, not fixed scores or a preset save.
Layout do jogo: marcadores numerados explicam controles e área jogável abaixo. A captura é um exemplo real, não uma pontuação fixa ou save pré-definido.
  1. Puzzle boardTabuleiro
  2. Passengers / parkingPassageiros / vagas
  3. Level / progressFase / progresso
  4. Hint / undo / restartDica / desfazer / reinício
Beep Out settings screen123
Settings: audio, language and available presentation options. Keep the game paused while changing settings and resume from the visible control.
Ajustes: áudio, idioma e opções de apresentação disponíveis. Altere com o jogo pausado e retome pelo controle visível.
  1. Music and sound effectsMúsica e efeitos sonoros
  2. Motion, timer and color symbolsMovimento, tempo e símbolos nas cores
  3. Graphics and interface languageGráficos e idioma da interface

Customize your game

Personalize o jogo

Back up the original package first. Edit only the files for this buyer edition, change one thing at a time and test the complete upload in a subfolder. Keep settings, assets and code versions together.

Guarde uma cópia do pacote original. Edite apenas esta edição, mude uma coisa por vez e teste o upload completo numa subpasta. Mantenha configurações, assets e código da mesma versão.

File / ArquivoPurpose / Finalidade
src/data/levels.jsonReadable generated level data used by the game.Dados legíveis das fases utilizados pelo jogo.
src/authoring/levels.sheets.ts and campaign.gen.jsonAuthoring source. npm run levels validates/regenerates the delivered level data; keep valid exits and passenger/parking rules.Arquivos de autoria. npm run levels valida e gera os dados; preserve saídas válidas e regras de passageiros/vagas.
src/config/tuning.tsGame and presentation tuning.Ajustes de jogo e apresentação.
src/i18n/strings.tsEnglish and Brazilian Portuguese interface strings.Textos da interface em inglês e português brasileiro.
src/ui/App.ts and src/styles.cssMenus, HUD, layout and input flow.Menus, indicadores, layout e fluxo de controles.
src/save/SaveStore.tsVersioned local campaign records, settings and cosmetic unlocks.Recordes da campanha, ajustes e cores desbloqueadas no navegador.
public/logo-wide.png, logo-stacked.png and audio/Replace logos/audio while preserving file paths, then rebuild.Troque logos/áudio mantendo os caminhos e gere novo build.

The file map refers to this Beep Out source/ project. Edit source/, run npm run build, and replace the hosted game/ contents with the complete dist/ output. Copying TypeScript files into the hosted game does not update its compiled bundle.

O mapa usa o projeto source/ deste Beep Out. Edite source/, execute npm run build e substitua game/ pelo conteúdo completo de dist/. Copiar TypeScript para o site não atualiza o bundle compilado.

Branding: update the HTML title, source title/brand configuration and actual image/logo files together. Language text lives in the dictionaries listed above. Do not claim an extra interface language until every key and narrow-screen layout has been reviewed. Cosmetic changes do not automatically change gameplay.

Marca: altere o título HTML, a configuração de nome e os arquivos reais de logo em conjunto. Traduções ficam nos dicionários acima. Só anuncie um idioma extra após revisar todas as chaves e o layout estreito. Alterações cosméticas não mudam a regra automaticamente.

cd source
npm ci
npm test
npm run build
# Copy ALL contents of source/dist/ to game/ and upload that complete output.

For compiled-source development use Node.js 22.12 or newer and npm. The prepared Vite config keeps JavaScript, CSS and JSON readable. Do not re-enable minification for the sold runtime. Keep npm dependency versions/lockfile and third-party licenses. Node is not needed on the buyer’s web hosting.

Para desenvolver os jogos compilados, use Node.js 22.12 ou superior e npm. O Vite entregue mantém JavaScript, CSS e JSON legíveis. Não religue minificação no runtime vendido. Preserve versões/lockfile e licenças. A hospedagem do comprador não precisa de Node.

Local records privacy and updates

Recordes locais privacidade e atualizações

Progress and settings use versioned localStorage keys. Records are specific to the browser/site and may disappear when browser data is cleared. This edition sends no score, nickname or gameplay event to Polar Games or a portal. There is no online scoreboard to install.

Progresso e ajustes usam chaves versionadas de localStorage. Recordes são específicos do navegador/site e podem desaparecer ao limpar seus dados. Esta edição não envia pontuação, apelido ou evento para Polar Games ou portal. Não há quadro online para instalar.

Back up saved data before changing storage keys, rules versions or schemas. Rule-version changes may intentionally reset incompatible records. Preserve the current game rules when only changing art. Replace the complete deployed game during updates; do not mix hashed files from different versions.

Faça backup dos dados antes de mudar chaves, versões de regra ou formato do save. Uma versão de regra pode zerar recordes incompatíveis. Preserve a regra ao trocar apenas arte. Substitua o jogo completo ao atualizar; não misture arquivos de versões diferentes.

Troubleshooting and frequently asked questions

Soluções e perguntas frequentes

Do I need Node.js, PHP or a database to play?Preciso de Node.js, PHP ou banco para jogar?

No. Upload game/ to static HTTP/HTTPS hosting. Node.js is only an optional source-development tool for the compiled games. PHP and databases are not included or required.

Não. Suba game/ numa hospedagem HTTP/HTTPS estática. Node.js serve apenas para desenvolver o código dos jogos compilados. PHP e banco não são necessários.

Can I double-click index.html?Posso abrir index.html com dois cliques?

Use a web server. ES modules, fonts and browser security make file:// unreliable. Opening the HTML locally from disk is not the installation procedure.

Use um servidor web. Módulos ES, fontes e segurança tornam file:// inadequado. Abrir o HTML do disco não é o procedimento de instalação.

Which folder should I upload?Qual pasta devo subir?

Only the contents of game/, keeping index.html and its folders together. Do not upload the ZIP, developer source, dependencies, documentation or internal working files as the playable root.

Somente o conteúdo de game/, mantendo index.html e as pastas juntos. ZIP, código de desenvolvimento, dependências e documentação não são a raiz jogável.

Can I install in a subfolder or iframe?Posso instalar em subpasta ou iframe?

Yes, asset paths are relative. Use an HTTP/HTTPS URL and give the iframe sufficient visible height. Keep browser storage enabled if progress must survive reloads.

Sim, os caminhos são relativos. Use HTTP/HTTPS e altura suficiente no iframe. Permita armazenamento do navegador para preservar progresso.

Why is sound silent before the first interaction?Por que o som não toca antes do primeiro toque?

Browsers require a click/tap before audio. Start through the game UI, check device/browser volume and in-game sliders. After returning from another app, resume through the visible UI.

O navegador exige clique/toque. Inicie pela interface, confira o volume do aparelho/navegador e os controles do jogo. Ao voltar de outro aplicativo, retome pela interface.

Are scores shared between devices?Os recordes sincronizam entre aparelhos?

No. Records and progress are local to this browser, profile and site origin. Another domain, browser, private session or device has its own data. There is no account or cloud save.

Não. Progresso e recordes pertencem a este navegador, perfil e origem do site. Outro domínio, navegador, sessão privada ou aparelho usa dados próprios. Sem conta ou nuvem.

What if localStorage is unavailable?E se localStorage estiver indisponível?

Gameplay remains available, but saving may be temporary. Private browsing, embedded storage restrictions, quota errors and cleared browser data can prevent persistence. Do not promise permanent or cross-device records.

O jogo continua disponível, mas o salvamento pode ser temporário. Modo privado, restrições de iframe, falta de espaço e limpeza de dados impedem persistência. Não prometa recordes permanentes ou sincronizados.

Can I add online ranking or multiplayer?Posso adicionar ranking online ou multiplayer?

This download intentionally excludes both. Such work needs its own backend, security model, implementation and tests. There is no hidden switch that connects to Polar Games services.

Esta edição exclui ambos. Isso exige backend, segurança, implementação e testes próprios. Não existe interruptor oculto para acessar serviços da Polar Games.

Does the item include ads, earnings or portal acceptance?O item inclui anúncios, ganhos ou aprovação em portal?

No advertising account, SDK service, portal acceptance, native app or revenue guarantee is included. The delivered standalone is ad-free. Integration into third-party systems is custom development.

Não inclui conta publicitária, serviço de SDK, aprovação em portal, aplicativo nativo ou garantia de ganhos. A edição entregue é sem anúncios. Integrações são desenvolvimento separado.

How do I reset progress?Como apagar progresso?

Clear only this game’s saved key in your browser developer tools. This is permanent for that browser. Copy/export the value first if you need a backup; never clear all site data casually on a shared domain.

Remova somente a chave deste jogo nas ferramentas do navegador. Isso é permanente nesse navegador. Copie/exporte o valor antes para ter backup; não limpe todos os dados de um domínio compartilhado sem necessidade.

Why do files fail after an update?Por que arquivos falham após atualizar?

Upload the whole new game/ together and preserve relative paths. Do not mix a new HTML with old hashed JS/CSS. Hard-reload to clear ordinary browser cache. This edition installs no service worker.

Suba toda a nova game/ em conjunto e mantenha os caminhos. Não misture HTML novo e JS/CSS antigo. Recarregue sem cache. Esta edição não instala service worker.

Can I replace the name, art and music?Posso trocar nome, arte e música?

Yes, follow the file map and dependency notices. Compiled games require rebuilding source changes. Only use replacement assets you may distribute. Keep the provided dependency/font license notices.

Sim, siga o mapa de arquivos e as licenças. Jogos compilados exigem novo build após alterar código. Use apenas assets que possa distribuir e preserve as licenças de dependências/fontes.

Does the package work offline?Funciona offline?

All runtime assets are bundled locally and no online gameplay service is required. They still must be served over HTTP/HTTPS; this is not an installed offline PWA and no service worker download/cache is promised.

Os assets ficam locais e não há serviço online obrigatório. Ainda é necessário servir por HTTP/HTTPS; não é uma PWA offline instalada e não há promessa de cache por service worker.

Which browsers and devices are supported?Quais navegadores e aparelhos usar?

Use current Chrome, Edge, Firefox or Safari with JavaScript and Canvas/WebGL support as required below. Responsive browser checks do not replace testing on your own physical devices and hosting.

Use Chrome, Edge, Firefox ou Safari atuais, com JavaScript e Canvas/WebGL conforme os requisitos abaixo. Testes responsivos não substituem testar seus aparelhos físicos e hospedagem.

What does item support cover?O que o suporte cobre?

Use the marketplace item support channel with your purchase details and a reproducible report. Support follows the marketplace policy. Hosting administration, new features, major reskins and custom integrations are separate services. No fixed response-time or lifetime commitment is made.

Use o suporte do item no marketplace, com os dados da compra e um relato reproduzível. O suporte segue a política do marketplace. Hospedagem, funções novas, grandes mudanças visuais e integrações são serviços separados. Sem promessa de prazo fixo ou suporte vitalício.

Why does a clear vehicle stop in parking?Por que um carro livre para no estacionamento?

From level 4, a vehicle whose color does not match the next passenger waits in a parking space. It leaves automatically when its passenger is next. Too many wrong colors fill the lot.

A partir da fase 4, o veículo de cor diferente do próximo passageiro espera numa vaga. Sai automaticamente quando chega sua vez. Cores erradas demais lotam as vagas.

Can I change levels by editing only the deployed JSON?Posso editar só um JSON no site?

The default runtime is bundled. Edit the developer authoring/data files, validate the levels, rebuild and replace the complete game/ output together.

O runtime padrão é compilado. Edite os arquivos de autoria/dados do desenvolvedor, valide, gere o build e substitua toda a saída de game/ em conjunto.

Documentation support and updates

Documentação suporte e atualizações

Use the marketplace item support channel for help with the delivered item. Include item/version, browser/device, exact hosted URL, steps, expected/actual result, screenshot and console/network error. Never send passwords, tokens or private customer data. Updates focus on fixes and improvements without a fixed schedule.

Use o suporte do item no marketplace. Informe item/versão, navegador/aparelho, URL exata, passos, resultado esperado/obtido, captura e erro do console/rede. Nunca envie senhas, tokens ou dados privados. Atualizações focam correções e melhorias, sem calendário fixo.

Item: Beep Out standalone 1.0.1
Browser/device:
Hosted URL:
Steps to reproduce:
Expected / actual:
Screenshot / error:
Customization already applied:

Briefing for a development assistant

Briefing para assistente de desenvolvimento

Copy this brief when asking for a change. It keeps the buyer edition separate from the publisher’s original games.

Copie este briefing ao pedir uma mudança. Ele mantém esta edição separada dos jogos originais do autor.

Work only in this Beep Out standalone buyer package. Read this manual and the source README. Preserve the game rules, existing saves and relative asset paths. Keep ranking local, with no PHP, network multiplayer, publisher backend or portal SDK. Keep shipped runtime JS/CSS/JSON readable. For compiled source run npm test and npm run build, then replace game/ with the full dist/. Test launch, play, result, pause, settings, language and save/reload on desktop/mobile. Report exact files, tests and remaining limits. Do not deploy or publish unless I ask.

Developer utilities and the Plop reference

Utilitários de desenvolvimento e a referência ao Plop

The earlier manual mentioned Plop in a shared explanatory paragraph. Plop is a separate Polar Games title, not a tool, dependency or optional utility included or needed by Beep Out. That unrelated paragraph has been replaced with Beep Out-specific instructions. The optional development utilities actually included here are npm run levels (validate/regenerate campaign data), npm test (source checks), npm run typecheck and npm run build (produce dist/). They are only needed for development/customization; running the delivered game/ requires no Node.js tool on the web server.

O manual anterior mencionava Plop num parágrafo explicativo compartilhado. Plop é outro jogo da Polar Games, não uma ferramenta, dependência ou utilitário opcional deste Beep Out. O parágrafo foi substituído por instruções específicas. Os utilitários realmente incluídos são npm run levels (validar/gerar fases), npm test (testes), npm run typecheck e npm run build (gerar dist/). Servem para desenvolvimento/personalização; game/ não exige Node.js no servidor.

Credits and third party licenses

Créditos e licenças de terceiros

Game design, code and publisher assets: Polar Games. Bundled dependency/font notices are in THIRD-PARTY-LICENSES/ and the supplied vendor files. The marketplace license governs the game item; third-party notices retain their own terms. Music, effects and voice files included in this package are listed by path in the package manifest. Replacement assets require your own appropriate permissions.

Design, código e assets do autor: Polar Games. Licenças de dependências/fontes ficam em THIRD-PARTY-LICENSES/ e nos arquivos vendor. A licença do marketplace rege o item; terceiros mantêm seus próprios termos. Músicas, efeitos e vozes estão listados no manifesto do pacote. Assets substitutos exigem permissões adequadas.

Custom development

Desenvolvimento sob medida

Custom reskins, new mechanics, online services and platform integrations are separate from item support. Discuss the scope first through the marketplace contact channel or willian@polargames.com.br. No hosted multiplayer, lifetime support or guaranteed revenue comes with this download.

Mudanças visuais completas, novas mecânicas, serviços online e integrações são separados do suporte do item. Converse sobre o escopo pelo marketplace ou willian@polargames.com.br. A compra não inclui multiplayer hospedado, suporte vitalício ou receita garantida.