Lumi - Guia do comprador

Instalação, ajustes, fases, idiomas e suporte do Lumi 1.0.0.

Guia de personalização: mude arte, som, textos e fases →

EnglishPortuguêsEspañol

Visão geral

Lumi é um jogo de quebra-cabeça com plataformas em HTML5. Lumi é uma lagarta de lanterna de papel: ela anda numa grade, cai com a gravidade, come frutas para crescer e, a partir do Mundo 2, solta o último pedaço da cauda como uma lanterna que fica onde cair. Coma todas as frutas para abrir o portal e entre nele.

  • 40 fases em 4 mundos (10 em cada), todas conferidas pelo solucionador incluído.
  • 3 estrelas por fase, dicas, desfazer ilimitado, reiniciar, tela de toque para começar, tela de final.
  • Teclado, setas na tela e deslize. Celular (em pé e deitado), tablet, computador e tela ultrawide.
  • 14 idiomas na interface. Efeitos sonoros e música incluídos.
  • HTML, CSS e JavaScript puros. Sem etapa de build, sem framework, sem código de servidor.
Uma fase do Mundo 1: Lumi, duas frutas e o portal (1280×720).
Uma fase do Mundo 1: Lumi, duas frutas e o portal (1280×720).

Instalar no seu site

  1. Descompacte o pacote.
  2. Envie o conteúdo da pasta game/ para qualquer hospedagem (hospedagem compartilhada, uma CDN, Netlify, GitHub Pages...).
  3. Abra index.html no navegador. Só isso.

Abra o jogo por http:// ou https://. Dar dois cliques em index.html no seu computador (um endereço file://) também funciona na maioria dos navegadores, mas o som e o progresso salvo podem ser bloqueados nesse modo.

Colocar dentro de uma página (iframe)

<iframe src="https://your-site.com/lumi/index.html" width="960" height="540" style="border:0" allow="autoplay; fullscreen"></iframe>

O jogo ocupa o tamanho que o quadro tiver, em pé ou deitado.

Portais de jogos

O jogo mostra primeiro uma tela de "toque para começar", para que o navegador libere o som depois do primeiro toque. Não há nenhuma requisição externa: fontes, arte e som estão todos dentro da pasta.

Requisitos

  • Para publicar: qualquer hospedagem de arquivos estáticos. Sem PHP, banco de dados ou Node.js.
  • Para jogar: uma versão atual do Chrome, Edge, Firefox, Safari ou Opera, no computador ou no celular.
  • Para usar as ferramentas de fases (opcional): Node.js 18 ou mais novo.

Como jogar e as telas

  • Mover: setas do teclado ou WASD, as setas na tela, ou um deslize.
  • Soltar a cauda (a partir do Mundo 2): Space, o botão da lanterna, ou toque duplo no modo deslize. Lumi precisa ter pelo menos 3 pedaços.
  • Desfazer: Z ou o botão de desfazer, quantas vezes quiser. Reiniciar: R ou o botão de reiniciar. Dica: H ou a lâmpada. Pausa: Esc ou o botão de pausa.
  • As frutas são sólidas: só a cabeça come. Os espinhos mandam Lumi de volta um passo. Um botão de pressão abre a porta enquanto algo está em cima dele; uma lanterna solta conta. Algumas salas são escuras: só Lumi, as lanternas dela e o portal dão luz.
  • Estrelas: 3 para o menor número de passos (a "meta"), 2 para até 35% a mais, 1 por terminar.
Escolha de fase: 10 fases por mundo, com as estrelas ganhas em cada uma.
Escolha de fase: 10 fases por mundo, com as estrelas ganhas em cada uma.
Fase concluída: estrelas, passos e os botões de fases, jogar de novo e próxima.
Fase concluída: estrelas, passos e os botões de fases, jogar de novo e próxima.

Ajustes

Quatro abas: som (efeitos, música, vibração), controles (setas ou deslize, tamanho dos botões, modo canhoto), acessibilidade (menos movimento, tremor de tela, salas escuras mais claras) e idioma.

Ajustes: som, controles, acessibilidade e idioma.
Ajustes: som, controles, acessibilidade e idioma.
No celular em pé, com as setas na tela.
No celular em pé, com as setas na tela.

O que vem no pacote

Pasta ou arquivoO que é
START-HERE.txtA versão curta deste guia.
DOCUMENTATION.html, CUSTOMIZATION.htmlAtalhos para este guia e para o guia de personalização.
ANSWER-CARD.htmlA solução de todas as fases, para imprimir ou deixar à mão.
documentation/Os guias em inglês, português e espanhol, e as imagens deles.
game/O jogo, pronto para enviar.
source/O mesmo jogo mais as ferramentas de fases (tools/) e o package.json. Edite aqui e depois copie para game/.
THIRD-PARTY-LICENSES/A licença da fonte.
CHANGELOG.txtHistórico de versões.

Dentro de game/

ArquivoO que faz
index.htmlA página: telas, botões e ícones (SVG embutido).
css/style.cssTodas as cores, tamanhos e regras de layout da interface.
js/config.jsNúmeros do toque do jogo, seus ajustes (LUMI_CONFIG) e os textos em inglês e português.
js/i18n.jsOs outros 12 idiomas e a lista de idiomas.
js/levels.jsAs 40 fases, desenhadas em texto.
js/levels-sol.jsO menor número de passos e a solução de cada fase (escrito pelo solucionador).
js/sim.jsAs regras do quebra-cabeça (sem desenho).
js/game.jsDesenho, animação e efeitos.
js/ui.jsTelas, controles, ajustes e progresso salvo.
js/scene.js, js/fx.js, js/audio.js, js/fit.jsCena de fundo, molas e partículas, som, e texto que encolhe para caber no botão.
assets/Arte (.webp), som (sfx/, music/, .mp3) e a fonte (fonts/).

Todos os arquivos são legíveis (sem minificação) e comentados.

Ajustes

Abra game/js/config.js e procure LUMI_CONFIG:

var LUMI_CONFIG = { hintsPerLevel: 3, rewardedAd: null };
AjusteSignificado
hintsPerLevelDicas grátis em cada fase. 0 significa ilimitadas.
rewardedAdnull, ou a sua função que mostra um vídeo com recompensa. Quando as dicas acabam, o jogo mostra um botão "+1 dica" que chama essa função.
debugtrue mostra o botão de solução para todo mundo (veja abaixo). Deixe de fora quando for publicar.

Vídeo com recompensa para dicas extras

var LUMI_CONFIG = {
  hintsPerLevel: 3,
  rewardedAd: function (done) {
    // mostre seu anúncio aqui e depois:
    done(true);   // true = o jogador assistiu e ganha mais 1 dica
  }
};

Números do toque do jogo

O bloco FEEL no começo de config.js guarda todos os números de animação (tempo do passo, achatamento, tremor de tela, pausa no impacto, raio de luz nas salas escuras...). Mude um número, recarregue a página e sinta a diferença.

Fases

Cada fase em js/levels.js é um pequeno desenho feito de caracteres, da linha de cima para baixo:

{ id: "my-level", world: 1, name: { en: "My Level", pt: "Minha fase" },
  rows: [
    '..........',
    '.......X..',
    '..o...###.',
    '#####.....',
  ],
  snake: [[2, 2], [1, 2], [0, 2]] },
CaractereSignificado
#Bloco (chão e paredes)
.Vazio
oFruta
XPortal (um por fase)
^Espinhos
_Botão de pressão (um bloco com um botão em cima)
DPorta, aberta pelo botão
  • snake lista os pedaços de Lumi como [column, row], cabeça primeiro, contados a partir de 0 no canto superior esquerdo. Todo pedaço precisa começar numa célula vazia.
  • world vai de 1 a 4 e escolhe a arte, a música e onde a fase aparece. dark: true cria uma sala escura.
  • O id precisa ser único: o progresso salvo usa esse valor.

Confira suas fases

Depois de mudar levels.js, rode o solucionador dentro de source/. Ele prova que cada fase pode ser terminada e escreve o menor número de passos (a meta das 3 estrelas) e a solução que a dica usa:

npm run solve

Depois npm run answers refaz o cartão de respostas. Copie js/levels.js e js/levels-sol.js para game/js/.

Uma fase que não está em levels-sol.js não pode ser jogada: rode sempre o solucionador depois de editar as fases.

Botão de solução e cartão de respostas

Acrescente ?debug ao endereço (por exemplo index.html?debug) para liberar todas as fases e ganhar um botão rosa de jogar ao lado da dica. Clique nele (ou aperte P) e o jogo reinicia a fase e joga a solução, mostrando a sequência de passos na parte de baixo. Clique de novo para parar.

Modo debug (?debug): o botão rosa joga a solução e os passos aparecem embaixo.
Modo debug (?debug): o botão rosa joga a solução e os passos aparecem embaixo.

?lv=12 abre a fase 12 direto; dá para combinar os dois: index.html?debug&lv=12.

O ANSWER-CARD.html traz as mesmas soluções no papel: as setas são passos e o ponto laranja é "soltar a cauda".

Idiomas

Inglês, português, espanhol, francês, alemão, italiano, holandês, polonês, turco, indonésio, russo, japonês, coreano e chinês simplificado. O jogo começa no idioma do navegador quando ele é um desses, senão em inglês; o jogador pode trocar nos ajustes.

  • Os textos nunca quebram linha nem saem do botão: quando uma tradução é longa, só as letras ficam menores.
  • A fonte incluída (Baloo 2) cobre os alfabetos latinos. Russo, japonês, coreano e chinês usam a fonte do aparelho.
  • Para mudar um texto ou acrescentar um idioma, veja o guia de personalização.

Dados salvos

O progresso e os ajustes ficam salvos no navegador (localStorage, chave lumi.v1): fases liberadas, melhor número de passos por fase, idioma, volumes e opções de controle. Nada é enviado a um servidor. Limpar os dados do site apaga o progresso.

Editar o código-fonte

O jogo não tem etapa de build: os arquivos em source/ são os mesmos que rodam. Você só precisa do Node.js para as ferramentas opcionais.

  1. Instale o Node.js 18 ou mais novo em nodejs.org.
  2. Abra um terminal na pasta source/.
  3. Use os comandos abaixo.
ComandoO que faz
npm startServidor local em http://localhost:5317/ (alguns navegadores bloqueiam som e progresso em file://).
npm testRoda os testes das regras e resolve todas as fases.
npm run solveO mesmo, e escreve js/levels-sol.js.
npm run answersRefaz documentation/answer-card.html.

Não há nada para instalar com npm install: as ferramentas não têm dependências.

Nomes internos

O código foi escrito por um estúdio brasileiro e alguns nomes estão em português. Os mais comuns:

NomeSignificado
fase, fasesfase, fases
frutafruta
bloco, bloco-pedrabloco, bloco de pedra
espinhosespinhos
botao, portabotão de pressão, porta
portal-fechado, portal-abertoportal fechado, portal aberto
gomo, cabecapedaço do corpo, cabeça
lanterna-bloco, pedestal, borlalanterna solta, seu suporte, borla da cauda
fundo-w1, fundo-p1fundo do mundo 1 deitado, em pé
ilha-baseparte de baixo da ilha flutuante

Atualizar o jogo e limpar o cache

Os navegadores guardam arquivos antigos. Depois de enviar uma versão nova, troque o nome da pasta ou acrescente uma versão aos endereços dos arquivos no index.html (por exemplo js/ui.js?v=2), e recarregue com Ctrl+F5 para testar.

Dúvidas e problemas

  • Sem som. Os navegadores só liberam o som depois de um toque ou de uma tecla: é para isso que serve a tela de "toque para começar". Confira o volume nos ajustes e o botão de mudo na tela de título.
  • O jogo não abre no meu computador. Abra por um endereço da web ou com npm start, não com dois cliques no arquivo.
  • O progresso sumiu. Ele fica no navegador: outro navegador, uma janela anônima ou dados do site apagados começam do zero.
  • Uma fase que editei não abre. Rode npm run solve e copie levels-sol.js de novo.
  • Posso remover um idioma? Pode: apague a linha dele em LUMI_LANGS, no fim de js/i18n.js.
  • Posso vender como app? A licença da sua compra define o que você pode fazer; veja os termos de licença do marketplace.

Suporte e créditos

Dúvidas sobre instalar ou personalizar: willian@polargames.com.br. Envie o endereço onde o jogo está publicado e o que você mudou.

Jogo, arte, som e código por Polar Games. Fonte: Baloo 2 (SIL Open Font License 1.1, em THIRD-PARTY-LICENSES/).