FirstBook Engine

Documentação Oficial

Bem-vindo(a) à documentação da FirstBook Engine, uma ferramenta focada em produtividade para escritores. Ela processa uma sintaxe simples, similar a Markdown, para gerar um livro digital formatado, com múltiplos temas e uma interface minimalista.

Guia de Sintaxe

O coração da Engine é a sua formatação automática para diferentes tipos de linhas de conteúdo. Para garantir a formatação correta, cada regra de sintaxe deve estar em sua própria linha.

Formato de Linha	Estrutura necessária	Resultado no leitor	Exemplo rápido
Capítulo	Começa com ##	Título de Capítulo destacado.	## Capítulo 2: A Missão
Abertura de Fala	[NOME] - [AÇÃO]	Nome em negrito e Ação em itálico.	[Slenderman] - [Do meio da névoa, ele sai e seus tentáculos sacolejavam.]
Fala Direta	Começa com — " e termina com "	Diálogo em cor de destaque.	— "O pacote está seguro."
Pensamento	Começa com — { e termina com }	Texto em cor de destaque secundária.	— {Essa é a parte que eu odeio.}
Quebra de Ação	Começa e termina com *	Texto de ação em itálico.	*O vento uivou na noite*
Bloco Narrativo	Envolto por <NT> e </NT>	Bloco de texto narrativo destacado.	<NT>Observação do narrador.</NT>

Parágrafos de Narração

• Narração Padrão: Qualquer linha que não corresponda a uma das sintaxes acima será tratada como um parágrafo de narração.
• Quebra de Parágrafo: Para iniciar um novo parágrafo, basta deixar uma linha em branco no editor.

---

Funcionalidades da Engine

1. Troca de Temas

A Engine possui um seletor de temas flutuante no canto superior direito (ícone de paleta), permitindo a troca instantânea da aparência.

• Cyber: Tema padrão. Fundo escuro, detalhes em ciano e roxo, com efeitos de scanline e ruído estático para uma estética futurista, recentemente curti o estilo cyberpunk.
• Sepia: Fundo claro (pergaminho), texto em tons de marrom, ideal para uma experiência de leitura clássica (e dor nos olhos).
• Terminal: Fundo preto com texto verde, simulando um terminal de computador antigo, acho verde legal.
• First Book: Tema oficial com uma paleta de tons escuros, roxos e avermelhados.

2. Modos de Visualização

• Modo Edição: Apresenta a área de texto à esquerda e uma pré-visualização em tempo real à direita (No PC). É aqui que você escreve sua história e vizualiza em tempo real o resultado final (Rimou).
• Modo Leitura: Exibe o texto final renderizado em tela cheia, sem distrações, otimizado para a leitura.

3. Menu de Configurações

Acessível pelo ícone de engrenagem na tela principal, este menu oferece controle sobre:

• Efeito Scanline: Permite ativar ou desativar os efeitos de scanline e ruído no tema Cyber.
• Limpar Progresso: Apaga todo o texto do editor e do salvamento automático, após uma confirmação de segurança.

4. Métricas e Download

• Exportar HTML: O botão "Salvar HTML" gera um único arquivo .html auto-contido. Este arquivo inclui seu texto e toda a lógica da Engine, permitindo que seu livro seja lido offline em qualquer navegador.
• Métricas em Tempo Real: Na parte inferior do Modo Edição, a barra de métricas calcula instantaneamente o número de palavras, linhas e caracteres.

5. Responsividade

A interface é projetada para funcionar tanto em desktops quanto em dispositivos móveis. (Espero que dê tudo certo)

---

Créditos

Obrigado por utilizar nossa engine simples, um abraço de: Eclesi Paixão e Kath.

No futuro muita coisa pode mudar.