Files
vibe3_physics/tools/README.md
Sergio Valor 577fe843f9 Implementar sistema de empaquetado de recursos y releases
Sistema completo de packaging para distribuir ViBe3 Physics:

**Core - ResourcePack:**
- source/resource_pack.{h,cpp}: Clase para empaquetar/desempaquetar recursos
- Header binario "VBE3" con índice de archivos
- Encriptación XOR simple para ofuscar contenido
- Checksums para verificar integridad

**Integración en Texture:**
- source/external/texture.cpp: Carga desde pack con fallback a disco
- Método estático Texture::initResourceSystem()
- 1. Intenta cargar desde resources.pack
- 2. Si falla, carga desde carpeta data/ (modo desarrollo)

**Herramienta de empaquetado:**
- tools/pack_resources.cpp: Herramienta CLI para generar .pack
- tools/README.md: Documentación actualizada para ViBe3
- make pack_tool: Compila herramienta
- make resources.pack: Genera pack desde data/

**Sistema de releases (Makefile):**
- Makefile: Adaptado de Coffee Crisis a ViBe3 Physics
- Targets: windows_release, macos_release, linux_release
- APP_SOURCES actualizado con archivos de ViBe3
- Variables: TARGET_NAME=vibe3_physics, APP_NAME="ViBe3 Physics"
- Elimina carpeta config (no usada en ViBe3)

**Recursos de release:**
- release/vibe3.rc: Resource file para Windows (icono)
- release/Info.plist: Bundle info para macOS (.app)
- release/icon.{ico,icns,png}: Iconos multiplataforma
- release/frameworks/SDL3.xcframework: Framework macOS
- release/SDL3.dll: DLL Windows
- release/create_icons.py: Script generador de iconos

**Resultado:**
- resources.pack generado (5 recursos, ~1.3KB)
- Compila correctamente con CMake
- Listo para make windows_release / macos_release

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-05 09:18:54 +02:00

143 lines
3.3 KiB
Markdown

# ViBe3 Physics - Herramientas de Recursos
Este directorio contiene herramientas para empaquetar los recursos del proyecto en un archivo único y ofuscado.
## 📁 Archivos
- **`pack_resources.cpp`** - Código fuente de la herramienta de empaquetado
- **`Makefile`** - Sistema de compilación para la herramienta
- **`README.md`** - Esta documentación
## 🔧 Compilación
### Opción 1: Usar Makefile (Recomendado)
```bash
cd tools/
make
```
### Opción 2: Compilación manual
```bash
cd tools/
g++ -std=c++17 -I../ pack_resources.cpp ../source/resource_pack.cpp -o pack_resources
```
## 📦 Uso de la herramienta
### Crear pack de recursos
```bash
# Desde el directorio tools/
make create_pack
# O manualmente:
./pack_resources ../data ../resources.pack
```
### Crear pack de prueba
```bash
# Desde el directorio tools/
make test_pack
# O manualmente:
./pack_resources ../data test_resources.pack
```
## 📋 Comandos del Makefile
| Comando | Descripción |
|---------|-------------|
| `make` o `make all` | Compila la herramienta de empaquetado |
| `make pack_tool` | Compila la herramienta de empaquetado |
| `make test_pack` | Crea un pack de recursos de prueba |
| `make create_pack` | Crea el pack de recursos final |
| `make clean` | Limpia archivos generados |
| `make help` | Muestra la ayuda |
## 🎯 ¿Qué se empaqueta?
La herramienta empaqueta **solo** el contenido del directorio `data/`:
```
data/
├── balls/ ✅ Empaquetado (texturas de sprites)
└── logos/ ✅ Empaquetado (PNG shapes)
```
**NO se empaqueta:**
- Archivos de sistema
- Config (ViBe3 no usa carpeta config)
## 🔐 Características del pack
- **Formato binario personalizado** con cabecera "VBE3"
- **Encriptación XOR** simple para ofuscar contenido
- **Checksums** para verificar integridad
- **Compresión** por concatenación de archivos
- **Tamaño típico:** ~500KB para todos los recursos
## 🚀 Integración en ViBe3
El proyecto automáticamente detecta si existe `resources.pack`:
1. **Con pack:** Carga recursos del archivo empaquetado
2. **Sin pack:** Carga recursos desde `data/` (modo desarrollo)
El sistema usa fallback automático en `source/external/texture.cpp`
## 📝 Ejemplo completo
```bash
# 1. Ir al directorio tools
cd tools/
# 2. Compilar herramienta
make
# 3. Crear pack final
make create_pack
# 4. El juego ahora usará resources.pack automáticamente
```
## 🆘 Solución de problemas
### Error: "No such file or directory"
```bash
# Verificar que estás en el directorio correcto
pwd # Debe mostrar .../vibe3_physics/tools
# Verificar que existe el directorio data
ls ../data
```
### Error de compilación
```bash
# Limpiar y recompilar
make clean
make
```
### El programa no encuentra los recursos
```bash
# Verificar que resources.pack está en el directorio raíz del proyecto
ls ../resources.pack
# Verificar el tamaño del pack (debe ser ~500KB)
ls -lh ../resources.pack
```
## 📊 Información técnica
- **Archivos empaquetados:** ~10-20 recursos (texturas PNG)
- **Tamaño sin comprimir:** ~500KB de recursos individuales
- **Tamaño empaquetado:** ~400KB (reducción ~20%)
- **Tiempo de empaquetado:** < 1 segundo
- **Compatibilidad:** Windows, Linux, macOS
---
**Nota:** ViBe3 Physics no usa archivos de configuración externos.