consultoria-as/novelasvm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit: NovelasVM platform with multi-engine support and Umineko Web integration

Browse Source
This commit is contained in:
consultoria-as
2026-06-14 23:51:40 +00:00
commit 8ded9cc4c8
24 changed files with 3688 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
docs/API.md Normal file
View File

@@ -0,0 +1,79 @@
## Catalogo global
### GET /games.json
Devuelve el catalogo completo de novelas publicadas.
```json
{
"games": [
{
"slug": "demo",
"title": "The Question",
"subtitle": "Demo oficial de Ren'Py",
"engine": "renpy",
"description": "...",
"cover": "/games/demo/web-presplash.jpg",
"version": "7.0",
"author": "Ren'Py Team",
"createdAt": "2026-06-14T10:35:09Z",
"entryPoint": "/games/demo/index.html",
"coopCoep": true
}
],
"updatedAt": "2026-06-14T22:07:10Z",
"version": "1.0"
}
```
## Metadatos por juego
### GET /games/<slug>/game.json
Generado por `build-novela.sh`. Contiene metadatos y configuracion del motor.
| Campo | Tipo | Descripcion |
|-------|------|-------------|
| `slug` | string | Identificador URL-friendly |
| `title` | string | Titulo mostrado |
| `subtitle` | string | Subtitulo opcional |
| `engine` | string | Motor: renpy, unity, web, onscripter, umineko-ru |
| `description` | string | Descripcion corta |
| `cover` | string | URL de la portada |
| `version` | string | Version del juego |
| `author` | string | Autor |
| `createdAt` | string ISO | Fecha de publicacion |
| `entryPoint` | string | URL para jugar |
| `coopCoep` | boolean | Si requiere headers COOP/COEP |
## meta.json de entrada
Archivo opcional en `/opt/novelas/projects/<slug>/meta.json`:
```json
{
"title": "Mi Novela",
"subtitle": "Subtitulo",
"description": "Descripcion.",
"author": "Autor",
"version": "1.0",
"cover": "/games/mi-novela/cover.jpg"
}
```
## Headers HTTP
### COOP/COEP (solo Ren'Py)
```
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Embedder-Policy: require-corp
```
Se aplican mediante snippets en `/etc/nginx/snippets/novelas-games/<slug>.conf`.
## Cache
- `games.json` y `game.json`: `no-store, no-cache, must-revalidate`.
- Assets estaticos: `public, immutable`, 30 dias.

99
docs/ARCHITECTURE.md Normal file
View File

@@ -0,0 +1,99 @@
# Arquitectura de NovelasVM
Este documento describe la arquitectura técnica de NovelasVM, sus componentes y el flujo de publicación de una novela visual.
## Componentes principales
```
┌──────────────────────────────────────────────────────────────────────┐
│ Cliente │
│ (navegador web) │
└───────────────────────────────┬──────────────────────────────────────┘
│ HTTP
┌───────────────────────────────▼──────────────────────────────────────┐
│ nginx (puerto 80) │
│ ┌─────────────────┐ ┌──────────────────┐ ┌─────────────────────┐ │
│ │ Portal web │ │ Juegos web │ │ /games/umineko/ │ │
│ │ /var/www/... │ │ /var/www/games/ │ │ → redirect :8081 │ │
│ └─────────────────┘ └──────────────────┘ └─────────────────────┘ │
└───────────────────────────────┬──────────────────────────────────────┘
│
┌───────────────────────┼───────────────────────┐
│ │ │
┌───────▼───────┐ ┌──────────▼─────────┐ ┌────────▼────────┐
│ build-novela │ │ detect-engine │ │ Umineko Web │
│ .sh │ │ .sh │ │ Docker :8081 │
└───────┬───────┘ └────────────────────┘ └─────────────────┘
│
┌───────▼───────┐
│ Ren'Py SDK │
│ /opt/novelas │
│ /tools/renpy│
└───────────────┘
```
## Flujo de publicación
1. El administrador coloca el proyecto en `/opt/novelas/projects/<slug>/`.
2. Opcionalmente añade `meta.json` con metadatos.
3. Ejecuta `/opt/novelas/bin/build-novela.sh <slug> <ruta> [motor]`.
4. `detect-engine.sh` identifica el motor si no se especifica.
5. Según el motor:
- **Ren'Py**: `renpy.sh launcher web_build` genera archivos web.
- **Unity/Web**: se copian tal cual.
- **ONScripter**: se copia motor OnscripterYuri + índice.
6. Se genera `game.json` con metadatos.
7. Se copia a `/var/www/novelas/games/<slug>/`.
8. Se genera snippet nginx si requiere COOP/COEP.
9. Se actualiza `/var/www/novelas/games.json`.
10. Se recarga nginx.
## Archivos clave
| Ruta | Propósito |
|------|-----------|
| `/opt/novelas/bin/build-novela.sh` | Pipeline de build y publicación |
| `/opt/novelas/bin/detect-engine.sh` | Detección de motor |
| `/opt/novelas/bin/umineko-web.sh` | Gestión del contenedor Umineko |
| `/opt/novelas/config/nginx-snippet.template` | Plantilla de snippet COOP/COEP |
| `/var/www/novelas/index.html` | Portal principal |
| `/var/www/novelas/assets/app.js` | Lógica del portal |
| `/var/www/novelas/assets/styles.css` | Estilos y temas |
| `/var/www/novelas/games.json` | Catálogo global |
| `/var/www/novelas/games/<slug>/game.json` | Metadatos por juego |
| `/etc/nginx/snippets/novelas-games/*.conf` | Headers específicos por juego |
## Catálogo global `games.json`
```json
{
"games": [
{
"slug": "demo",
"title": "The Question",
"subtitle": "Demo oficial de Ren'Py",
"engine": "renpy",
"description": "...",
"cover": "/games/demo/web-presplash.jpg",
"version": "7.0",
"author": "Ren'Py Team",
"createdAt": "2026-06-14T10:35:09Z",
"entryPoint": "/games/demo/index.html",
"coopCoep": true
}
],
"updatedAt": "2026-06-14T22:07:10Z",
"version": "1.0"
}
```
## Seguridad de headers
- `COOP`/`COEP` se aplican **solo** a juegos Ren'Py porque requieren `SharedArrayBuffer`.
- Unity WebGL y juegos web genéricos no los reciben para evitar bloqueo de recursos cross-origin.
## Escalabilidad
- Cada juego es independiente en `/var/www/novelas/games/<slug>/`.
- El portal carga el catálogo asíncronamente, por lo que el número de juegos solo afecta el tamaño de `games.json`.
- Para Umineko, el contenedor Docker es independiente y puede escalarse o moverse a otro host.

152
docs/DESIGN.md Normal file
View File

@@ -0,0 +1,152 @@
# Design System: NovelasVM Portal
---
name: NovelasVM Portal
type: Gaming / Visual Novel Catalog
themes:
- dark
- light
- immersive
principles:
- Clean, modern, game-store aesthetic.
- Theme switcher as a first-class feature.
- No emojis in UI; use inline SVG icons only.
- Animations restricted to transform and opacity.
- Responsive, mobile-first layout.
---
## Overview
Portal para descubrir, listar y lanzar novelas visuales alojadas en NovelasVM. Debe sentirse como una tienda de juegos indie o un launcher elegante, no como un directorio de archivos.
## Color Palette
### Theme: Dark Modern
- `--bg-primary`: #0a0a0a (main background)
- `--bg-surface`: #141414 (cards, navbar)
- `--bg-elevated`: #1f1f1f (hover states, dropdowns)
- `--text-primary`: #f5f5f5
- `--text-secondary`: #a0a0a0
- `--text-muted`: #666666
- `--accent`: #4e85bf
- `--accent-hover`: #3a6da3
- `--border`: #2a2a2a
- `--shadow`: rgba(0, 0, 0, 0.4)
- `--success`: #2ecc71
- `--warning`: #f1c40f
### Theme: Light Minimal
- `--bg-primary`: #fafafa
- `--bg-surface`: #ffffff
- `--bg-elevated`: #f3f4f6
- `--text-primary`: #111827
- `--text-secondary`: #4b5563
- `--text-muted`: #9ca3af
- `--accent`: #2563eb
- `--accent-hover`: #1d4ed8
- `--border`: #e5e7eb
- `--shadow`: rgba(0, 0, 0, 0.08)
### Theme: Immersive Atmospheric
- `--bg-primary`: #050510 (deep indigo-black)
- `--bg-surface`: rgba(20, 20, 40, 0.6)
- `--bg-elevated`: rgba(30, 30, 60, 0.7)
- `--text-primary`: #ffffff
- `--text-secondary`: rgba(255, 255, 255, 0.75)
- `--text-muted`: rgba(255, 255, 255, 0.45)
- `--accent`: #8b5cf6
- `--accent-hover`: #7c3aed
- `--border`: rgba(255, 255, 255, 0.12)
- `--shadow`: rgba(0, 0, 0, 0.5)
- `--gradient-start`: #1e1b4b
- `--gradient-mid`: #4c1d95
- `--gradient-end`: #0f172a
## Typography
- **Primary font**: Inter, system-ui, sans-serif
- **Display font**: Inter, weight 700
- **Monospace**: JetBrains Mono, monospace
Scale:
- Hero title: clamp(2rem, 5vw, 3.5rem)
- Section title: 1.75rem / weight 700
- Card title: 1.125rem / weight 600
- Body: 1rem / line-height 1.6
- Caption: 0.875rem
- Small: 0.75rem
## Spacing
Base unit: 0.25rem (4px)
- xs: 0.5rem
- sm: 0.75rem
- md: 1rem
- lg: 1.5rem
- xl: 2rem
- 2xl: 3rem
Max content width: 1280px, centered, with 1rem side padding.
## Components
### Navbar
- Fixed top, full width.
- Background: `--bg-surface` with `backdrop-filter: blur(12px)` in immersive theme.
- Border-bottom: 1px solid `--border`.
- Height: 64px.
- Logo left, theme switcher right.
### Game Card
- Aspect ratio cover image (16:9 or 4:3) at top.
- Rounded corners: 12px (theme dark/light) or 16px (immersive).
- Background: `--bg-surface`.
- Border: 1px solid `--border`.
- Shadow: subtle, lifting on hover (`transform: translateY(-4px)`).
- Badge showing engine (Ren'Py, Unity, Web).
- Title, subtitle, description (2 lines max).
- Primary CTA: "Jugar" button.
### Buttons
- Primary: accent background, white text, rounded-lg (8px), padding 0.6rem 1.2rem.
- Hover: darken accent, slight lift.
- Ghost: transparent with border.
### Theme Switcher
- Pill-shaped segmented control.
- Icons: moon (dark), sun (light), sparkle/glass (immersive).
### Engine Badge
- Small pill with icon + label.
- Ren'Py: purple/indigo tint.
- Unity: dark/black tint.
- Web: blue tint.
## Layout
- Header hero with title and subtitle.
- Filter bar (optional v1: just engine badges count or simple text).
- Grid of cards: 1 column mobile, 2 tablet, 3 desktop, 4 large.
- Footer with credits.
## Motion
- Entry: fade + translateY(16px → 0), 500ms ease-out.
- Card hover: translateY(-4px) + shadow increase, 200ms ease.
- Theme transition: 300ms ease on color/background/border properties.
- Loading skeleton: shimmer animation.
## Responsive
- Breakpoints: sm 640px, md 768px, lg 1024px, xl 1280px.
- Navbar collapses gracefully; theme switcher stays visible.
- Cards stack to single column below 640px.
## Do's and Don'ts
- Do use the CSS variables for theming.
- Do ensure WCAG AA contrast on all themes.
- Don't use emojis in the UI.
- Don't animate layout properties (width, height, margin).
- Don't use pure black (#000) in dark theme.
- Don't rely on external images for UI icons; use inline SVG.

140
docs/ENGINES.md Normal file
View File

@@ -0,0 +1,140 @@
# Guía de motores soportados
NovelasVM soporta varios motores de novelas visuales. Esta guía describe cómo preparar y publicar cada uno.
## Tabla de motores
| Motor | Extensión/detección | Build | URL resultante |
|-------|---------------------|-------|----------------|
| Ren'Py | `project.json`, `game/script.rpy` | Compilación web | `/games/<slug>/` |
| Unity WebGL | `Build/`, `TemplateData/`, `index.html` | Copia directa | `/games/<slug>/` |
| Web genérico | `index.html` | Copia directa | `/games/<slug>/` |
| ONScripter | `0.txt`, `nscript.dat`, `ons.cfg` | Copia + OnscripterYuri | `/games/<slug>/` |
| ONScripter-RU / Umineko | `*.file`, `default.cfg`, `chiru.file` | Contenedor Docker | `/games/umineko/` |
---
## Ren'Py
### Estructura esperada
```
mi-novela/
├── project.json
├── game/
│ ├── script.rpy
│ ├── images/
│ └── audio/
└── meta.json
```
### Comando
```bash
sudo /opt/novelas/bin/build-novela.sh mi-novela /opt/novelas/projects/mi-novela renpy
```
### Consideraciones
- Requiere `xvfb` para compilar sin display.
- El build puede tardar varios minutos.
- Se generan `index.html`, `renpy.js`, `renpy.wasm`, `renpy.data`, `game.zip`.
- Recibe headers `COOP`/`COEP` automáticamente.
---
## Unity WebGL
### Estructura esperada
```
mi-juego/
├── index.html
├── Build/
│ ├── mi-juego.data.gz
│ ├── mi-juego.framework.js.gz
│ ├── mi-juego.loader.js
│ └── mi-juego.wasm.gz
└── TemplateData/
├── style.css
└── UnityProgress.js
```
### Comando
```bash
sudo /opt/novelas/bin/build-novela.sh mi-juego /opt/novelas/projects/mi-juego unity
```
### Consideraciones
- No requiere compilación adicional.
- Asegúrate de que los nombres de archivo en `index.html` coincidan con los de `Build/`.
---
## Web genérico
### Estructura esperada
```
mi-web/
├── index.html
├── css/
├── js/
└── assets/
```
### Comando
```bash
sudo /opt/novelas/bin/build-novela.sh mi-web /opt/novelas/projects/mi-web web
```
### Consideraciones
- Cualquier proyecto con un `index.html` funciona.
- Si carga recursos externos, asegúrate de que CORS lo permita.
---
## ONScripter (genérico)
### Estructura esperada
```
mi-ons/
├── 0.txt # o nscript.dat
├── default.ttf
├── ons.cfg
├── backgrounds/
├── sprites/
└── sound/
```
### Comando
```bash
sudo /opt/novelas/bin/build-novela.sh mi-ons /opt/novelas/projects/mi-ons onscripter
```
### Consideraciones
- Usa OnscripterYuri web.
- Si el script está en `nscript.dat`, OnscripterYuri debería soportarlo.
- No soporta los archivos `.file` encriptados de ONScripter-RU (ver Umineko).
---
## ONScripter-RU / Umineko
Ver [`docs/UMINEKO.md`](UMINEKO.md) para la guía completa.
Resumen:
```bash
sudo /opt/novelas/bin/umineko-web.sh start
```
- Se sirve desde contenedor Docker en `http://IP:8081/`.
- El portal redirige desde `/games/umineko/`.

161
docs/INDEX.md Normal file
View File

@@ -0,0 +1,161 @@
# NovelasVM
Plataforma web aliada de Afterlife para ejecutar y probar novelas visuales directamente en el navegador. Soporta multiples motores: Ren'Py (WebAssembly), Unity WebGL, proyectos HTML5 personalizados y ONScripter-RU/Umineko Web.
## Información general
| Campo | Valor |
|-------|-------|
| VMID | 111 |
| Host Proxmox | Cisco1 (192.168.10.185) |
| IP estática | 192.168.10.111 |
| Gateway | 192.168.10.254 |
| DNS | 8.8.8.8, 8.8.4.4 |
| Recursos | 8 vCPUs, 16 GB RAM, 150 GB disco |
| SO | Ubuntu 24.04 LTS |
| Usuario admin | `novelas` |
| Web | http://192.168.10.111 |
## Estructura de directorios
```
/opt/novelas/
├── bin/
│ ├── build-novela.sh # Script principal: compila y publica novelas
│ └── detect-engine.sh # Detecta el motor de un proyecto
├── builds/ # Builds intermedias generadas
├── projects/ # Proyectos fuente de novelas
├── tools/
│ └── renpy/ # Ren'Py SDK 8.3.4 + web package
├── config/
│ └── nginx-snippet.template# Plantilla para snippets nginx
├── templates/
│ └── portal/ # Plantillas del portal web (NO USADAS EN RUNTIME)
└── docs/
├── README.md # Esta documentación
└── DESIGN.md # Sistema de diseño del portal
/var/www/novelas/ # Raíz servida por nginx
├── index.html # Portal principal
├── assets/ # CSS, JS e iconos del portal
│ ├── styles.css
│ ├── app.js
│ └── icons/
├── games.json # Catálogo global de juegos
└── games/
├── demo/ # The Question (Ren'Py)
├── web-demo/ # Ejemplo HTML5
├── unity-demo/ # Ejemplo Unity WebGL
└── umineko/ # Solo cover.jpg; juego en contenedor Docker
/etc/nginx/snippets/novelas-games/
└── *.conf # Headers COOP/COEP por juego Ren'Py
```
## Motores soportados
| Motor | Detección automática | Compilación | Headers COOP/COEP |
|-------|---------------------|-------------|-------------------|
| Ren'Py | `project.json` o `game/script.rpy` | Si, via `renpy.sh launcher web_build` | Si |
| Unity WebGL | `Build/`, `TemplateData/` e `index.html` | No, copia directa | No |
| Web genérico | `index.html` | No, copia directa | No |
| ONScripter estándar | `0.txt`, `nscript.dat`, `ons.cfg` | Copia + OnscripterYuri web | No |
| ONScripter-RU / Umineko | `*.file` + `default.cfg` | Contenedor Docker `umineko_web_asm` | No |
## Cómo agregar una novela visual
1. Coloca el proyecto en `/opt/novelas/projects/<nombre>`.
2. (Opcional) Añade un archivo `meta.json` en la raíz del proyecto:
```json
{
"title": "Mi Novela",
"subtitle": "Subtítulo opcional",
"description": "Breve descripción de la novela.",
"author": "Tu nombre",
"version": "1.0",
"cover": "/games/mi-novela/cover.jpg"
}
```
3. Ejecuta como root o con sudo:
```bash
/opt/novelas/bin/build-novela.sh <nombre> /opt/novelas/projects/<nombre>
```
También puedes forzar el motor:
```bash
/opt/novelas/bin/build-novela.sh <nombre> /opt/novelas/projects/<nombre> renpy
```
4. La novela quedará disponible en `http://192.168.10.111/games/<nombre>/`.
## Umineko no Naku Koro ni (ONScripter-RU Web)
Umineko utiliza el motor ONScripter-RU compilado a WebAssembly mediante el proyecto `umineko_web_asm`. Se sirve desde un contenedor Docker dedicado y se accede a traves de una redireccion en nginx.
### Estructura
```
/opt/novelas/tools/umineko-web-asm/ # Fuente del contenedor
├── run-umineko-web.sh # Script para levantar/actualizar
├── docker-compose.yml
└── ...
/opt/novelas/projects/umineko/ # Archivos del juego
/var/www/novelas/games/umineko/cover.jpg # Portada para el portal
```
### URL
- Portal: `http://192.168.10.111/games/umineko/` (redirige al contenedor)
- Directa: `http://192.168.10.111:8081/`
### Gestión del contenedor
```bash
# Levantar o recrear
cd /opt/novelas/tools/umineko-web-asm
./run-umineko-web.sh
# Detener
docker-compose down
# Estado
docker ps
docker logs -f umineko-web-asm_umineko-web_1
```
### Modos de hosting
Edita `run-umineko-web.sh` para cambiar `HOSTING_MODE`:
- `local` (actual): sirve los archivos originales. Inicio rapido.
- `production`: convierte PNG→WebP, MP4→WebM, etc. Tarda en iniciar la primera vez.
- `remote`: el usuario sube sus propios archivos desde el navegador.
## Portal web
El portal principal (`http://192.168.10.111/`) muestra el catálogo de novelas disponibles con:
- Diseño moderno y responsive.
- Selector de temas: oscuro, claro e inmersivo.
- Tarjetas con portada, metadatos y badge del motor.
- Carga dinámica desde `/games.json`.
La preferencia de tema se guarda en `localStorage` del navegador.
## Servicios instalados
- nginx (puerto 80)
- ufw (firewall: 22, 80, 443)
- docker + docker-compose
- nodejs + npm
- python3 + pip
- xvfb (para compilar Ren'Py Web sin display)
## Diseño
El sistema de diseño del portal está documentado en `/opt/novelas/docs/DESIGN.md`. Se inspiró en los design systems de [designmd.ai](https://designmd.ai) y define tokens para los tres temas visuales.
## Notas de seguridad
- Cambiar el password de root y del usuario `novelas` si aun no se ha hecho.
- Considerar habilitar HTTPS con Caddy o certbot.
- Evaluar autenticación si las novelas son privadas.
- Los headers `Cross-Origin-Opener-Policy` y `Cross-Origin-Embedder-Policy` solo se aplican a juegos Ren'Py, ya que son los unicos que requieren `SharedArrayBuffer`. Unity WebGL y juegos web genericos no los necesitan y podrian romperse con ellos.

209
docs/INSTALL.md Normal file
View File

@@ -0,0 +1,209 @@
# Guía de instalación
Esta guía describe cómo instalar NovelasVM desde cero en un servidor Ubuntu.
## Tabla de contenidos
1. [Preparación del sistema](#preparación-del-sistema)
2. [Usuario y directorios](#usuario-y-directorios)
3. [Instalación de dependencias](#instalación-de-dependencias)
4. [Instalación de Ren'Py SDK](#instalación-de-renpy-sdk)
5. [Instalación de OnscripterYuri web](#instalación-de-onscripteryuri-web)
6. [Configuración de nginx](#configuración-de-nginx)
7. [Instalación del portal](#instalación-del-portal)
8. [Configuración de Umineko Web](#configuración-de-umineko-web)
9. [Verificación final](#verificación-final)
---
## Preparación del sistema
Actualiza el sistema:
```bash
sudo apt update && sudo apt upgrade -y
```
Configura una IP estática. Edita `/etc/netplan/00-installer-config.yaml` o el archivo correspondiente:
```yaml
network:
version: 2
ethernets:
eth0:
addresses:
- 192.168.10.111/24
routes:
- to: default
via: 192.168.10.254
nameservers:
addresses:
- 8.8.8.8
- 8.8.4.4
```
Aplica:
```bash
sudo netplan apply
```
---
## Usuario y directorios
Crea el usuario `novelas` y los directorios base:
```bash
sudo useradd -m -s /bin/bash novelas
sudo mkdir -p /opt/novelas/{bin,builds,projects,tools,config,templates/portal,docs}
sudo mkdir -p /var/www/novelas/{games,assets}
sudo chown -R novelas:novelas /opt/novelas
```
---
## Instalación de dependencias
```bash
sudo apt install -y \
nginx \
docker.io \
docker-compose \
python3 \
python3-pip \
nodejs \
npm \
xvfb \
p7zip-full \
git \
curl \
wget \
imagemagick \
ufw
```
Habilita Docker:
```bash
sudo systemctl enable --now docker
sudo usermod -aG docker novelas
```
---
## Instalación de Ren'Py SDK
Descarga Ren'Py SDK con el paquete web:
```bash
sudo mkdir -p /opt/novelas/tools/renpy
cd /opt/novelas/tools/renpy
sudo curl -sL -O https://www.renpy.org/dl/8.3.4/renpy-8.3.4-sdk.tar.bz2
sudo tar -xjf renpy-8.3.4-sdk.tar.bz2
sudo mv renpy-8.3.4-sdk/* .
sudo rm -rf renpy-8.3.4-sdk renpy-8.3.4-sdk.tar.bz2
sudo chown -R novelas:novelas /opt/novelas/tools/renpy
```
Verifica:
```bash
/opt/novelas/tools/renpy/renpy.sh --version
```
---
## Instalación de OnscripterYuri web
Descarga la última versión web:
```bash
sudo mkdir -p /opt/novelas/tools/onscripter-yuri
cd /opt/novelas/tools/onscripter-yuri
VERSION="0.7.6"
curl -sL -o onsyuri_v${VERSION}_web.7z \
https://github.com/YuriSizuku/OnscripterYuri/releases/download/v${VERSION}/onsyuri_v${VERSION}_web.7z
7z x -y onsyuri_v${VERSION}_web.7z
rm onsyuri_v${VERSION}_web.7z
sudo chown -R novelas:novelas /opt/novelas/tools/onscripter-yuri
```
---
## Configuración de nginx
Copia la configuración del repositorio:
```bash
sudo cp /opt/novelas/repo/config/nginx.conf /etc/nginx/sites-available/novelas
sudo ln -sf /etc/nginx/sites-available/novelas /etc/nginx/sites-enabled/novelas
sudo rm -f /etc/nginx/sites-enabled/default
sudo nginx -t
sudo systemctl reload nginx
```
> Nota: el archivo `config/nginx.conf` del repositorio es una plantilla; ajústala según tu IP/dominio.
---
## Instalación del portal
Copia los archivos del portal:
```bash
sudo cp -r /opt/novelas/repo/var-www/* /var/www/novelas/
sudo chown -R www-data:www-data /var/www/novelas
sudo find /var/www/novelas -type f -exec chmod 644 {} \;
sudo find /var/www/novelas -type d -exec chmod 755 {} \;
```
Copia los scripts:
```bash
sudo cp /opt/novelas/repo/bin/* /opt/novelas/bin/
sudo chmod +x /opt/novelas/bin/*.sh
sudo chown -R novelas:novelas /opt/novelas/bin
```
---
## Configuración de Umineko Web
Clona el repositorio del contenedor:
```bash
sudo mkdir -p /opt/novelas/tools
cd /opt/novelas/tools
sudo git clone --depth 1 https://github.com/VictoriqueMoe/umineko_web_asm.git umineko-web-asm
sudo cp /opt/novelas/repo/bin/umineko-web.sh umineko-web-asm/run-umineko-web.sh
sudo chmod +x umineko-web-asm/run-umineko-web.sh
```
Edita `run-umineko-web.sh` con la ruta correcta a los archivos del juego y la IP del servidor.
Coloca los archivos de Umineko en `/opt/novelas/projects/umineko/` y luego:
```bash
sudo /opt/novelas/bin/umineko-web.sh start
```
---
## Verificación final
```bash
# nginx
sudo systemctl is-active nginx
# Docker
sudo docker ps
# Portal
curl -s http://localhost/games.json
# Umineko redirect
curl -sI http://localhost/games/umineko/
```
Accede con tu navegador a `http://192.168.10.111/`.

59
docs/PORTAL.md Normal file
View File

@@ -0,0 +1,59 @@
# Portal web
El portal web es la interfaz principal de NovelasVM. Muestra el catálogo de novelas disponibles y permite cambiar entre temas visuales.
## Archivos
- `var-www/index.html` — Estructura del portal.
- `var-www/assets/styles.css` — Tokens y estilos de los tres temas.
- `var-www/assets/app.js` — Lógica de carga del catálogo, renderizado y temas.
## Funcionalidades
- **Catálogo dinámico**: carga `/games.json` y renderiza tarjetas.
- **Selector de temas**: oscuro, claro, inmersivo. Persistencia en `localStorage`.
- **Badges de motor**: cada tarjeta muestra el motor (Ren'Py, Unity, Web, ONScripter-RU).
- **Portadas**: si `cover` está definido en `game.json`, se muestra; si no, placeholder.
- **Responsive**: de 1 columna en móvil hasta 4 en pantallas grandes.
- **Sin emojis**: todos los iconos son SVG inline.
## Metadatos mostrados
Cada tarjeta muestra:
- Portada (16:9)
- Badge del motor
- Título y subtítulo
- Descripción (máximo 2 líneas)
- Versión, autor y fecha
- Botón "Jugar"
## Personalización
### Cambiar tipografía
Edita la fuente en `var-www/index.html`:
```html
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&..." rel="stylesheet">
```
Y actualiza `--font-sans` en `styles.css`.
### Añadir un nuevo tema
1. Añade `[data-theme="mi-tema"]` en `styles.css` con sus tokens.
2. Añade un botón en `index.html` con `data-theme-value="mi-tema"`.
3. Opcionalmente actualiza `THEMES` en `app.js`.
### Añadir motor/badge
1. Añade el color `--engine-<motor>` en cada tema de `styles.css`.
2. Añade clase `.engine-badge.<motor>`.
3. Añade entrada en `engineConfig` de `app.js`.
4. Añade orden en `engineOrder` del sort.
## Ordenación
Los juegos se ordenan:
1. Por motor: `renpy`, `umineko-ru`, `unity`, `web`.
2. Por título alfabéticamente dentro de cada motor.

43
docs/SECURITY.md Normal file
View File

@@ -0,0 +1,43 @@
## Credenciales
- Cambia las contrasenas de root y novelas tras la instalacion.
- No compartas el token de Gitea ni otras credenciales.
## HTTPS
Se recomienda habilitar HTTPS con certbot:
```bash
sudo apt install certbot python3-certbot-nginx
sudo certbot --nginx -d tu-dominio.com
```
## Headers COOP/COEP
Se aplican solo a juegos Ren'Py. Aplicarlos globalmente romperia Unity WebGL y juegos web que carguen recursos externos.
## Firewall
Mantener solo los puertos necesarios abiertos:
```bash
sudo ufw allow 22/tcp
sudo ufw allow 80/tcp
sudo ufw allow 443/tcp
sudo ufw allow 8081/tcp # Umineko Web
```
## Contenido con copyright
No subas a repositorios publicos:
- Archivos de juegos (`/opt/novelas/projects/*`).
- Builds publicadas (`/var/www/novelas/games/*`).
- SDKs de terceros (`/opt/novelas/tools/renpy`, `onscripter-yuri`).
Este repositorio solo debe contener el codigo de la plataforma.
## Docker
- El contenedor de Umineko expone el puerto 8081.
- Considera restringir el acceso a 8081 si solo se usara mediante nginx.

59
docs/THEMES.md Normal file
View File

@@ -0,0 +1,59 @@
## Temas disponibles
El portal incluye tres temas visuales:
1. **Oscuro moderno** (`data-theme="dark"`)
2. **Claro minimalista** (`data-theme="light"`)
3. **Atmosferico inmersivo** (`data-theme="immersive"`)
## Tokens CSS
Los tokens se definen en `var-www/assets/styles.css` bajo los selectores `[data-theme="..."]`.
### Tokens comunes
| Token | Uso |
|-------|-----|
| `--bg-primary` | Fondo principal |
| `--bg-surface` | Fondo de tarjetas y navbar |
| `--bg-elevated` | Superficies elevadas |
| `--text-primary` | Texto principal |
| `--text-secondary` | Texto secundario |
| `--text-muted` | Texto atenuado |
| `--accent` | Color de acento |
| `--accent-hover` | Acento en hover |
| `--border` | Bordes |
| `--shadow-*` | Sombras |
| `--engine-*` | Colores de badges de motor |
### Ejemplo: tema oscuro
```css
[data-theme="dark"] {
--bg-primary: #0a0a0a;
--bg-surface: #141414;
--bg-elevated: #1f1f1f;
--text-primary: #f5f5f5;
--text-secondary: #a0a0a0;
--accent: #4e85bf;
--border: #2a2a2a;
}
```
## Tipografia
- **Sans**: Inter, system-ui
- **Mono**: JetBrains Mono
## Transiciones
Los cambios de tema animan `background-color`, `color` y `border-color` durante 300ms.
## Anadir un tema nuevo
1. Copia el bloque de un tema existente en `styles.css`.
2. Cambia el selector a `[data-theme="nuevo"]`.
3. Define nuevos valores para todos los tokens.
4. Anade un boton en `index.html` con `data-theme-value="nuevo"`.
5. Verifica contraste WCAG AA.

51
docs/TROUBLESHOOTING.md Normal file
View File

@@ -0,0 +1,51 @@
## El juego no aparece en el portal
1. Verifica que `games.json` existe:
```bash
curl -s http://localhost/games.json
```
2. Revisa los logs de nginx:
```bash
sudo tail -50 /var/log/nginx/novelas-error.log
```
3. Asegurate de que los permisos sean correctos:
```bash
sudo chown -R www-data:www-data /var/www/novelas
```
## Ren'Py no genera index.html
- Revisa el log del proyecto en `/opt/novelas/builds/<slug>/log.txt`.
- Asegurate de que `xvfb` este instalado.
- Aumenta el timeout en `build-novela.sh` si el proyecto es grande.
## Unity WebGL no carga
- Verifica que `index.html` referencie correctamente los archivos de `Build/`.
- Abre la consola del navegador para ver errores 404.
## Umineko no carga
1. Verifica que el contenedor este corriendo:
```bash
sudo docker ps
```
2. Revisa los logs:
```bash
sudo /opt/novelas/bin/umineko-web.sh logs
```
3. Verifica que el manifest se genero:
```bash
curl -sI http://localhost:8081/manifest.json
```
## Error 403/404 en assets
- Revisa permisos de `/var/www/novelas`.
- Verifica que nginx tenga acceso a los archivos.
## Cambio de tema no persiste
- Asegurate de que `localStorage` no este deshabilitado.
- El tema se guarda bajo la clave `novelasvm-theme`.

109
docs/UMINEKO.md Normal file
View File

@@ -0,0 +1,109 @@
## Descripcion
Umineko no Naku Koro ni utiliza el motor **ONScripter-RU**, que no es compatible con OnscripterYuri generico porque usa scripts encriptados en archivos `.file` (`en.file`, `es.file`, `ru.file`).
Para ejecutarlo en el navegador se utiliza el proyecto **umineko_web_asm**, que compila ONScripter-RU a WebAssembly mediante Emscripten.
## Requisitos
- Docker y docker-compose instalados.
- ~15 GB de espacio libre para la imagen y los assets.
- Archivos del juego en `/opt/novelas/projects/umineko/`.
## Estructura esperada del juego
```
/opt/novelas/projects/umineko/
├── en.file # Script principal (ingles)
├── es.file # Script en espanol
├── ru.file # Script en ruso
├── chiru.file # Coordenadas de imagenes
├── default.cfg # Configuracion del juego
├── game.hash # Hash de integridad
├── fonts/
├── backgrounds/
├── sprites/
├── graphics/
├── sound/
└── video/
```
## Instalacion del contenedor
```bash
sudo mkdir -p /opt/novelas/tools
cd /opt/novelas/tools
sudo git clone --depth 1 https://github.com/VictoriqueMoe/umineko_web_asm.git umineko-web-asm
sudo cp /opt/novelas/repo/bin/umineko-web.sh umineko-web-asm/run-umineko-web.sh
sudo chmod +x umineko-web-asm/run-umineko-web.sh
```
## Configuracion
Edita `/opt/novelas/tools/umineko-web-asm/run-umineko-web.sh`:
```bash
export GAME_PATH=/opt/novelas/projects/umineko
export PORT=8081
export HOSTING_MODE=local
export SITE_URL=http://192.168.10.111/games/umineko/
```
### Modos de hosting
- `local`: sirve los archivos originales. Inicio rapido.
- `production`: convierte PNG a WebP, MP4 a WebM, etc. Reduce tamano pero tarda en iniciar.
- `remote`: el usuario sube sus propios archivos desde el navegador.
## Gestion del contenedor
```bash
sudo /opt/novelas/bin/umineko-web.sh start
sudo /opt/novelas/bin/umineko-web.sh stop
sudo /opt/novelas/bin/umineko-web.sh restart
sudo /opt/novelas/bin/umineko-web.sh status
sudo /opt/novelas/bin/umineko-web.sh logs
sudo /opt/novelas/bin/umineko-web.sh update
```
## Integracion con nginx
El portal redirige `/games/umineko/` al puerto 8081:
```nginx
location /games/umineko/ {
return 301 http://192.168.10.111:8081/;
}
```
Asegurate de que el puerto 8081 este abierto en ufw.
## Portada
Coloca una imagen en:
```bash
/var/www/novelas/games/umineko/cover.jpg
```
Sera mostrada en el portal.
## Solucion de problemas
### El contenedor no arranca
```bash
sudo docker logs umineko-web-asm_umineko-web_1
```
### El juego no carga
- Verifica que `default.cfg` apunte a `game-script=en.file`.
- Comprueba que `chiru.file` y `game.hash` existan.
- Revisa la consola del navegador.
### Rendimiento lento
- Considera cambiar a `production` para assets optimizados.
- Asegurate de tener suficiente RAM y CPU.