kaichronicles

Kai Chronicles

Noviembre de 2021: la aplicación Kai Chronicles ya no se publica

Kai Chronicles es un jugador de juego para Lone Wolf Game Books. Solo los libros 1 - 13 son jugables. El jugador de juego puede ejecutarse como un sitio web o una aplicación Android. Puedes jugarlo en https://www.prochaon.org/staff/toni o descargar la aplicación de Google Play .

Este repositorio no contiene datos de libros de juegos. Los datos deben descargarse del sitio web del proyecto AON. Recuerde que los datos de los libros de juegos están bajo la licencia del proyecto AON, así que:

• No puede poner esta aplicación en un servidor web público (solo en su máquina local, para su propio uso). El único lugar donde se puede publicar este juego es en el sitio web del proyecto y
• No puedes redistribuir los datos de los libros de juegos de ninguna manera

La versión compatible con Android Mayor es 5.1 (API 22). La web se prueba con la última versión de Chrome y Firefox. Otros navegadores o/y versiones más antiguas pueden no funcionar.

Configuración

Compilar mecanografiado

npm install
npm run ts    # This compiles for node.js, generates code in src/js
npm run build # This compiles for browser, generates code in www/js

Descargue los datos del juego del proyecto:

npm run downloaddata

Esto requerirá Node.js (cualquier versión reciente), el comando zip y el cliente SVN en su ruta

Sitio web de configuración

npm run serve

Abra su navegador en http: // localhost: 5000.

Configuración de la aplicación Android

Instale los requisitos de Cordova 9.0 Android. Entonces:

npm run cordova-prepare
npm run cordova-build

Esto generará un archivo src/plataformas/android/build/salidas/apk/android-debug.apk con la aplicación Android.

Puede probar la aplicación con el emulador. Ábralo con Android Studio y luego:

npm run cordova-run

Cordova se instala como requisito NPM, por lo que cualquier otro comando está disponible en Node_Modules. Ejemplo:

node_modules/cordova/bin/cordova plugin list

De manera predeterminada, esta aplicación descargará los libros de la web Project Aon. Si necesita descargar los libros de su servidor web privado, puede cambiarlo en BookDownloadState.ts, método "Descargar Solía".

Configurar una imagen de Docker

Método opcional para ejecutar un sitio web local solo para jugar el juego

• Descargue e instale Docker y asegúrese de que esté en su variable de entorno de ruta
• Uso de un terminal (Linux o iOS) o PowerShell (Windows 10) navegue hasta el directorio del proyecto
• Escriba docker build -t kai:1.0 .
• Escriba docker run -p 8080:8080 kai:1.0
• Abra http: // localhost: 8080

Más información sobre este método aquí

Desarrollo

Las reglas de juego para cada libro se encuentran en www/data. "Mechanics-X" son las reglas del juego para el libro X. "Objects.xml" son los objetos del juego

Existe documentación (inhesada) para reglas, formatos de objeto y guardar formato de archivo de juego.

La implementación de reglas del juego se encuentra en SRC/TS/Controller/Mechanics y www/controlador/mecánica.

Si agrega "? Debug = True" a la URL del juego, aparecerán algunas herramientas de depuración. También puede usar las herramientas de desarrollador del navegador para preparar la tabla de acción para probar secciones individuales. Por ejemplo, en la consola puede ejecutar cosas como:

 kai . actionChartController . pick ( 'axe' )
kai . actionChartController . increaseMoney ( - 10 )

Hay algunos scripts para el desarrollo:

npm run downloaddata [booknumber] # Download books data from the Project Aon. Specify "booknumber" to download a single book
npm run lint          # Runs tslint over the Typescript code
npm run prepareversion [ -- [--debug] [KEYSTOREPASSWORD] ] # Prepare a version to upload on "dist" dir.
npm run cleandist     # Delete the "dist" dir
npm run ts            # Compile Typescript code for execution with node.js
npm run build         # Compile and pack Typescript code for execution with browser
npm run cleants       # Remove all code generated by the Typescript compiler
npm run reviewchanges BOOKNUMBER LANGUAGE # Compare the currently publised app book version with the latest version on the PAON SVN
npm run test          # Run tests

"NPM Run Prepare Version" generará una versión para cargar en Google Play y el sitio web del Proyecto AON en el directorio "DIST". Luego, "KeyStorePassword" es la contraseña para el almacén de claves. Si no se especifica, se generará un .apk sin firmar. Sospecho que no es una buena idea publicar tiendas clave en Github. Opción "--debug" generará una versión debuggable

"NPM Run ReviewChanges" es útil para verificar los cambios de libros de la última versión publicada. Requiere comandos iconv, dwdiff y menos en su camino.

Se puede encontrar una "Guía" para desarrollar nuevos libros en DOC/ReadMe-Develowing.md

Pruebas

Las pruebas se ejecutan con Selenium Web Driver and Jest. Actualmente, las pruebas se ejecutarán solo con Chrome, y Selenium necesitará un "controlador de navegador". Consulte https://www.selenium.dev/documentation/en/webdriver/driver_requirements para las instrucciones de instalación. Las pruebas se encuentran en SRC/TS/Pruebas. Asegúrese de que TypeScript para Node.js se compila antes de ejecutar pruebas:

npm run ts
npm run test

Licencia

Mit. Esta aplicación utiliza el siguiente código / recursos de terceros:

• La representación HTML, el procesamiento XML de libros y la licencia de proyecto AON HTML contiene código tomado de Lone Wolf Adventures, por Liquid State Limited
• El logotipo y las salpicaduras de Lone Wolf se toman directamente o se adaptan del proyecto español Aon
• Los íconos del botón son creados por Delapouite, LORC y Willdabeast, y se distribuyen desde http://game-icons.net/ (licencia CC)
• Bootstrap (MIT)
• Toastr (MIT)
• Filesaver.js (MIT)
• jQuery (licencia jQuery)
• Apache Cordova (Licencia Apache)
• xml.js, código tomado de http://syssgx.github.io/xml.js/ (licencia CC)
• cordova-plugin-zip (licencia)
• CORDOVA-PLUGIN-ZEEP (Licencia de Apache 2.0)
• CORDOVA-FILECHOOSER (Licencia de Apache 2.0)
• CORDOVA-PLUGIN-COPYTODOWNLOAD (MIT)
• Cordova-plugin-Document-Contract (MIT)

Gracias a LSI por dejarnos usar su cuenta de Google Play para esta aplicación.