Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/allnulled/novelator
Lenguaje para escribir novelas y pasarlas a un JSON.
https://github.com/allnulled/novelator
Last synced: 1 day ago
JSON representation
Lenguaje para escribir novelas y pasarlas a un JSON.
- Host: GitHub
- URL: https://github.com/allnulled/novelator
- Owner: allnulled
- Created: 2023-10-23T11:06:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-29T09:08:29.000Z (about 1 year ago)
- Last Synced: 2024-10-28T14:53:51.621Z (21 days ago)
- Language: PEG.js
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# novelator
Lenguaje para escribir novelas y pasarlas a un JSON.
## Editor en línea
Puedes probarlo ya en la aplicación:
- [https://allnulled.github.io/novelator/editor.html](https://allnulled.github.io/novelator/editor.html)
También puedes probar un motor básico usando **novelator-lector**:
- [https://github.com/allnulled/novelator-lector](https://github.com/allnulled/novelator-lector)
## Instalación
```sh
npm install --save novelator
```
## Uso
Una vez instalado, puedes usarlo así desde consola:
```sh
./node_modules/.bin/novelator novela.nvl
```
Esto producirá automáticamente un fichero JSON llamado `novela.json`, o imprimirá el error de sintaxis pertinente.
## Sintaxis
Para escribir novelas, tienes las siguientes sentencias que puedes ir concatenando con saltos de línea.
### Sentencia de diálogo
Cuando solo habla 1 personaje, se escribe así:
` dice: cosas que dice el personaje.`
Cuando hablan varios personajes a la vez, se escribe así:
` y y dicen: cosas que dicen estos personajes.`
Para escribir un monólogo de múltiples líneas, se escribe así:
```
dice:
Esto es un monólogo.
Puedes usar múltiples líneas.
Sin embargo, cuando hagas 2 saltos de línea juntos, estarás terminando el monólogo.
dice: esto ya forma parte de la siguiente intervención.
```
Nótese que se termina la intervención cuando se escriben 2 saltos de línea seguidos.
### Sentencia de acción
Cuando solo actúa 1 personaje, se escribe así:
` hace lo que sea.`
` se mueve.`
` se queda quieto.`
` piensa.`
Cuando lo hacen varios personajes, se escribe así:
` y hacen lo que sea.`
` y callan.`
Para escribir una acción de múltiples líneas, se escribe así:
```
Esto es una acción de múltiples líneas.
Puedes usar múltiples líneas.
Sin embargo, cuando hagas 2 saltos de línea juntos, estarás terminando esta acción.
hace otra cosa.
```
Nótese que se termina la acción cuando se escriben 2 saltos de línea seguidos.
### Sentencia de cambio de fondo
Para cambiar de fondo se escribe así:
`Cambio de fondo: nueva_imagen_de_fondo.png`
### Sentencia de cambio de escena
Para cambiar de escena se escribe así:
`Cambio de escena: Título de la nueva escena`
### Sentencia de cambio de capítulo
Para cambiar de capítulo se escribe así:
`Cambio de capítulo: Título del nuevo capítulo`
## Uso como API
Para usarlo como API, tienes dos opciones.
### Opción 1. API para Node.js.
```js
const Novelator_parser = require("novelator");
Novelator_parser.parse(texto_novelator);
```
### Opción 2. API para navegadores.
```html
Novelator_parser.parse(texto_novelator);
```
## ¿Qué más?
Bueno. Con esto te aseguras que tu novela puede ser pasada a formato JSON. Ya está, luego con el JSON puedes hacer muchas cosas.