README.md

Adventure

Une application pour gérer le brouillard de guerre et le suivi des PNJs dans les jeux de rôle sur table (RPG).

Table des matières

• À propos du projet
• Fonctionnalités
• Prise en main
  • Prérequis
  • Installation
• Utilisation
• Licence

À propos du projet

Adventure est une application conçue pour les passionnés de jeux de rôle sur table. Elle simplifie la gestion du brouillard de guerre et le suivi des personnages non-joueurs (PNJs) pour améliorer l'immersion dans vos parties.

Construite avec Node.js, cette application est compatible avec Linux, macOS et Windows.

Fonctionnalités

• Gestion du brouillard de guerre : révélez ou cachez des zones dynamiquement pendant le jeu.
• Suivi des PNJs : conservez les détails des PNJs tels que leurs noms, rôles et statistiques.
• Multi-plateforme : fonctionne sur tous les principaux systèmes d'exploitation.

Prise en main

Prérequis

Assurez-vous d'avoir installé :

• Node.js (v14 ou plus récent)
• npm (Node Package Manager)

Installation

1. Clonez le dépôt :

   git clone https://github.com/sharkanator/adventure.git
   cd adventure

2. Installez les dépendances :

   npm install

3. Créez un fichier .env dans le répertoire racine et ajoutez votre clé API ChatGPT :

   OPENAI_API_KEY=key-from-chatgpt
   

4. Lancez l'application automatiquement avec :

   npm start

Utilisation

• Accédez à l'application via votre navigateur à l'adresse http://localhost:3000.
• Utilisez les outils pour gérer le brouillard de guerre et suivre vos PNJs.

Licence

Distribué sous la licence MIT. Consultez le fichier LICENSE pour plus d'informations.