App-QuestHelper

QuestHelper is a WebApp that allows you to easily create the LuxDialogues config files via an interactive graphical interface.

🚀 Key Features of QuestHelper

• Multi-Conversations & Multiple Quests : Manage multiple conversations and quests within each adventure, offering a rich and dynamic experience.

• Create Interactive Dialogues : Easily add custom dialogues for your characters, including interactive questions, redirections, and player choices.

• Customizable Characters & Dialogue Presets : Create and manage multiple characters with dialogue presets, enabling varied interactions tailored to each scenario.

• Dynamic Character Name Editing : Easily modify character names within dialogues for maximum flexibility, depending on the game's context.

• Interactive data : All the data is stored on the server, so multiple users can edit quests at the same time.

• Responsive Design : Enjoy a seamless experience across Desktop PC, Laptop, and Mobile devices.

🛠️ How to Install

Note

Ensure that npm is installed on your system. You can verify the installation by running npm -v.

If you encounter an error, please refer to the npm installation guide for assistance.

1. Install the repository: Open your terminal and run the following command to download the git repository:

git clone git@github.com:Game-Of-Arkadia/App-QuestHelper.git
cd App-QuestHelper

2. Install dependencies: After pulling the repo, install the node modules with:

npm install

This can take several minutes depending of your internet connexion.

3. Running QuestHelper: After installation, you can start QuestHelper by executing:

npm run app

Launch the Backend server in another terminal using:

npm run server

This will start the QuestHelper server, which you can access at http://localhost:8082

🐳 Configure QuestHelper as a service

Configuration

You can customize settings using environment variables:

Variable	Purpose	Default Value
QSTH_HOST	Set the host address	::
QSTH_PORT	Set the port number	8082
QSTH_ALLOWED_HOST	Controls allowed hosts (true to accept any host)	true
QSTH_BASE_URL	Subfolder name when hosting under a subpath (ex: use app for site.com/app). Leave empty for root.	''
QSTH_API_URL	API URL for backend api services ( empty to use the same host)	http://localhost:3001

Example:

# bind to all interfaces on port 3000, allow any host, and serve under /questhelper
npm run server& &&
QSTH_HOST='0.0.0.0' QSTH_PORT=3000 QSTH_ALLOWED_HOST='true' QSTH_BASE_URL='questhelper' npm run app

Since the app normally uses the root (/) path, you can safely use a custom domain or reverse proxy without conflicts. If you set QSTH_BASE_URL, ensure your reverse proxy forwards the subpath (and rewrites requests) to the app accordingly.

API Endpoints

You can retrieve all the data using the API with:

• GET /api/data - Retrieve all application data
• POST /api/data - Save application data
• GET /api/health - Health check endpoint

💬 Support

If you have any questions, suggestions, or need assistance, please open an issue.

---

Created by Pamplemom - Enjoy !