Usando Squiffy desde la línea de comandos

Instalación

Como alternativa a la versión web y al editor gráfico descargable, Squiffy esta también disponible como un módulo Node de línea de comandos. Este funciona en Windows, Mac y Linux.

Para instalar el compilador de Squiffy, primero instala Node.js.

Despues, instala el módulo squiffy desde npm, para ello teclea esto en la línea de comandos o Terminal:

npm install squiffy -g

La opción -g instala el compilador de Squiffy de forma global, para que puedas facilmente ejecutarlo desde cualquier directorio.

Si la instalación falla: En Mac o Linux, si obtienes un error en la instalación, prueba usando sudo:

sudo npm install squiffy -g

Uso

Puedes crear un fichero Squiffy en cualquier editor de textos - Notepad, Sublime Text, TextEdit etc.

Los ficheros Squiffy son ficheros de tetxto con extensión .squiffy.

Para transformar un fichero Squiffy en un fichero que funcione en un navegador web, colocate en su directorio y teclea lo siguiente en la linea de comandos:

squiffy mygame.squiffy

Squiffy escribira tres ficheros en el mismo directorio que se encuentra el fichero script: index.html, style.css y story.js. También puede escribir una copia de jQuery (usa la opción --cdn para que use jQuery desde la web en vez de crear dicho fichero).

Ejecuta index.html para jugar al juego.

Esta carpeta y ficheros puede ahora subirse a cualquier página web, y se ejecura de forma completa en el navegador web local del jugador (el fichero script con el código fuente .squiffyno es neesario que sea incluido).

El almacenamiento local del navegador web puede ser usado para salvar el estado del juego. Esto hace que el jugador puede cerrar su navegador, y la próxima vez que el regrese a la página, el juego automaticamente comenzara desde se dejo.

Nota: Incluso si recompilas el juego, el estado anterior sera cargado. Esto implica que cad vez que hagas un cambio en tu juego, sea necesario hacer click en el enlace Restart en la parte superior de la pantalla para ver dichos cambios.

Opciones

CDN

Usa --cdn para incorporar jQuery desde CDN en vez de incluir una copia local en tu juego.

HTTP Server

Usa --serve para comenzar un servidor HTTP local después de compilar. Opcionalmente, puedes especificar un puerto usando --port, p.e.

squiffy mijuego.squiffy --serve --port 31337

Solo Script

Usa --scriptonly para generar solo el fichero story.js. Puedes opcionalmente especificar tu propio nombre, p.e.

squiffy mijuego.squiffy --scriptonly miscript.js

Nombre de Plugin

Squiffy genera un fichero que incluye un pluging jQuery, permitiendote embeber tu juego en cualquier elemento HTML. Por defecto este pluging es llamado usando:

$('#element').squiffy()

Si tienes multiples juegos Squiffy en una misma página HTML, necesitaras usar un nombre diferente para cada uno de ellos. Puedes especificar el nombre del pluging usando la opción --pluginname.

Por ejemplo:

squiffy mijuego.squiffy --scriptonly --pluginname mijuego

Esto generara un fichero story.js conteniendo un pluging jQuery, icho pluging podrás añadirlo a cualquier elemento de una página HTML usando

$('#element').mijuego();