kaichronicles

Kai Chronicles

Novembre 2021: l'application Kai Chronicles n'est plus publiée

Kai Chronicles est un joueur de jeu pour Lone Wolf Game Books. Seuls les livres 1 à 13 sont jouables. Le lecteur de jeu peut fonctionner en tant que site Web ou application Android. Vous pouvez le jouer sur https://www.projectaon.org/staff/toni ou télécharger l'application à partir de Google Play .

Ce référentiel ne contient pas de données de livres de jeux. Les données doivent être téléchargées à partir du site Web du projet AON. N'oubliez pas que les données des livres de jeu sont sous la licence Project Aon, donc:

• Vous ne pouvez pas mettre cette application sur un serveur Web public (uniquement sur votre machine locale, pour votre propre usage). Le seul endroit où ce jeu peut être publié est sur le site Web du projet AON
• Vous ne pouvez pas redistribuer les données des livres de jeu de quelque manière que ce soit

La version prise en charge Android est 5.1 (API 22). Le Web est testé avec la dernière version de Chrome et Firefox. D'autres navigateurs ou / et versions plus anciennes peuvent ne pas fonctionner.

Installation

Compiler la dactylographie

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

Téléchargez les données du jeu du projet AON:

npm run downloaddata

Cela nécessitera Node.js (toute version récente), la commande ZIP et le client SVN sur votre chemin

Configuration du site Web

npm run serve

Ouvrez votre navigateur sur http: // localhost: 5000.

Configuration de l'application Android

Installez Cordova 9.0 Requeriments Android. Alors:

npm run cordova-prepare
npm run cordova-build

Cela générera un fichier src / plates-formes / Android / build / sorties / apk / android-debug.apk avec l'application Android.

Vous pouvez tester l'application avec l'émulateur. Ouvrez-le avec Android Studio puis:

npm run cordova-run

Cordova est installé en tant que requise NPM, de sorte que toute autre commande est disponible dans Node_Modules. Exemple:

node_modules/cordova/bin/cordova plugin list

Par défaut, cette application télécharge les livres à partir du projet AON Web. Si vous avez besoin de télécharger les livres depuis votre serveur Web privé, vous pouvez le modifier dans BookdownloadState.ts, méthode "Downloadasync".

Configurer une image Docker

Méthode facultative pour gérer un site Web local uniquement pour jouer au jeu

• Téléchargez et installez Docker et assurez-vous qu'il est dans votre variable d'environnement de chemin
• En utilisant un terminal (Linux ou iOS) ou PowerShell (Windows 10) accédez au répertoire du projet
• Type docker build -t kai:1.0 .
• Type docker run -p 8080:8080 kai:1.0
• Ouvert http: // localhost: 8080

Plus d'informations sur cette méthode ici

Développement

Les règles de jeu pour chaque livre sont situées sur www / data. "Mechanics-X" sont les règles de jeu pour le livre X. "objets.xml" sont les objets de jeu

Il existe une documentation (non) pour les règles, les formats d'objets et enregistrer le format de fichier de jeu.

La mise en œuvre des règles du jeu est à SRC / TS / Controller / Mechanics et WWW / Controller / Mechanics.

Si vous ajoutez "? Debug = true" à l'URL du jeu, certains outils de débogage apparaîtront. Vous pouvez également utiliser les outils du développeur du navigateur pour préparer le tableau d'action pour tester des sections individuelles. Par exemple, dans la console, vous pouvez exécuter des choses comme:

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

Il existe des scripts pour le développement:

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 PrepareVersion" générera une version à télécharger sur Google Play et le site Web du projet AON sur le répertoire "DIST". Ensuite, "KeyStorePassword" est le mot de passe du clés. S'il n'est pas spécifié, un .APK non signé sera généré. Je soupçonne que ce n'est pas une bonne idée de publier des clés de clés sur GitHub. L'option "- debug" générera une version débordante

"NPM Run ReviewChanges" est utile pour vérifier les modifications de la dernière version publiée par l'application. Il nécessite des commandes iconv, dwdiff et moins sur votre chemin.

Un "guide" pour développer de nouveaux livres peut être trouvé sur Doc / ReadMe-Developing.md

Tests

Les tests sont exécutés avec le pilote Web Selenium et la plaisanterie. Actuellement, les tests fonctionneront uniquement avec Chrome, et Selenium aura besoin d'un "pilote de navigateur". Voir https://www.selenium.dev/documentation/en/webdriver/driver_requirements pour les instructions d'installation. Les tests sont situés aux tests SRC / TS /. Assurez-vous que TypeScript pour Node.js est compilé avant d'exécuter des tests:

npm run ts
npm run test

Licence

Mit. Cette application utilise le code / ressources tiers suivant:

• Le rendu HTML, les livres de traitement XML et la licence de projet AON HTML contient du code pris à partir de Lone Wolf Adventures, par Liquid State Limited
• Le logo et les éclaboussures de Lone Wolf sont pris directement ou adaptés du projet espagnol aon
• Les icônes de bouton sont créées par Delapouite, LORC et Willdabeast, et distribuées à partir de http://game-icons.net/ (licence CC)
• Bootstrap (MIT)
• Toastr (MIT)
• Filessaver.js (MIT)
• jQuery (licence jQuery)
• Apache Cordova (Licence Apache)
• xml.js, code tiré de http://syssgx.github.io/xml.js/ (licence CC)
• Cordova-Plugin-Zip (Licence)
• Cordova-Plugin-Zeep (Apache Licence 2.0)
• Cordova-FileChooser (Apache License 2.0)
• Cordova-Plugin-CopyTodownload (MIT)
• Cordova-Plugin-Document-Contract (MIT)

Merci à LSI de nous avoir permis d'utiliser son compte Google Play pour cette application.