https://github.com/dvarrui/diamante
Mostrar diapositivas en el terminal.
https://github.com/dvarrui/diamante
ruby slides terminal text
Last synced: 15 days ago
JSON representation
Mostrar diapositivas en el terminal.
- Host: GitHub
- URL: https://github.com/dvarrui/diamante
- Owner: dvarrui
- License: mpl-2.0
- Created: 2026-04-30T09:48:01.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-07T10:56:32.000Z (2 months ago)
- Last Synced: 2026-05-07T12:28:15.769Z (2 months ago)
- Topics: ruby, slides, terminal, text
- Language: Ruby
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Diamante
Presentar diapositivas en el terminal.
## Instalación
* Instalar Ruby.
* Instalar la gema `gem install diamante`
## Modo de uso
```bash
$ diamante PATH/TO/CONFIG.yaml
```
* Crear una carpeta con el fichero de configuración (YAML) y las diapositivas en ficheros de texto. [Ver ejemplo](./examples/data/).
```bash
examples/data
├── 01.txt
├── 02.txt
├── 03.txt
└── 04.txt
```
* Ejecutar `diamante show examples/matrix.yaml`.
| Tecla | Función |
| ----- | ----------------------------- |
| q | Salir de la presentación |
| right | Ir a la siguiente diapositiva |
| left | Ir a la diapositiva anterior |
## Características
* El contenido de cada diapositiva va en un fichero de texto separado.
* El fichero de configuración tiene el siguiente formato:
```yaml
:game:
:bye: "Morpheus: 'Follow me.'"
:bg:
:scene: Matrix
:chars: "!#$%&\\\/()*+,-.01:;<=>?@[]^_oO{}|ª·¿•xX "
:fg:
:scene: Slides
:files: "examples/data/*.txt"
:ui:
:scene: UI
:header: "Gema diamante"
```
* Significado de los parámetros de configuración:
| Sección | Parámetro | Descripción |
| --------- | ----------- | -------------------- |
| `:game` | `:bye` | Mensaje de despedida |
| `:bg` | `:scene` | Escena de background |
| `:bg` | `:chars` | Caracteres para el efecto Matrix |
| `:fg` | `:scene` | Escena de foreground |
| `:fg` | `:files` | Ficheros de texto con las diapositivas |
| `:ui` | `:scene` | Escena del interfaz de usuario |
| `:ui` | `:header` | Título de la presentación |
## Desarrollo
* La biblioteca está hecha de forma modular para poder usar distintas escenas de background, foreground o user interface en el futuro.
* Actualmente no se están usando los parámetros `:scene`, pero en un futuro permitirán definir las escenas a cargar para reproducir la presentación.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/dvarrui/diamante.