Skip to content

Releases: Brotenko/QualityQuest

Initial Release

06 May 10:46
2be9397
Compare
Choose a tag to compare

Version 1.0.0 - Initial Release

Prerequisites

This software includes a web-based client which will be hosted directly by the software in form of a website. This website will inevitably need to save game-specific data, requiring the host to provide legal texts regarding cookies and general terms of service (see GDPR). Moreover the host might also need to provide a Legal Notice or About page, depending on the hosts location.
We provide placeholders for these purposes which can be replaced, or removed, depending on your needs. Said placeholders are located as following:

  • Cookies and Terms of Service: ../ServerLogic/PAClient/Shared/_Layout.cshtml
  • Terms of Service: ../ServerLogic/PAClient/TermsOfService.cshtml
  • Privacy: ../ServerLogic/PAClient/Privacy.cshtml
  • About: ../ServerLogic/PAClient/About.cshtml

We highly recommend setting everything up according to legal requirements, regardless of the location of the host and the userbase, to circumvent possible future issues with the law and law enforcement.

Setup

Make sure that Python3 is installed and Docker is running. Place a valid .pfx certificate in QualityQuest/ServerLogic. Run install_and_run.py with administrator privileges. The script offers you three options to start QualityQuest:

  1. (Install) Must have been run once to enable the other two options. Creates a new Docker image, the requested parameters are used to start a Docker container and run QualityQuest directly afterwards.
  2. (Configurate) Start QualityQuest from an existing Docker image and change the parameters for port and URL. Also resets parameters such as LogLevel and password from previous sessions.
  3. (Continue) Start QualityQuest and apply settings from previous sessions.

Maintenance / Known issues

In general it is sufficient to use option one in the script only once to generate a docker image. From there on, options two and three are perfectly sufficient for normal operation.
If somehow the ServerShell-Terminal is closed without stopping the ServerShell/qqservercontainer beforehand, you can use docker attach qqservercontainer to interact with the container again.

Possible issues and possible fixes:

  • Website or WebSocket not available?
    • Specify 'https://' explicitly for the website.
    • Check whether the sockets on your device are enabled or occupied by another service.
  • [Warn] Failed to Authenticate System.AggregateException: One or more errors occurred.
    • This Exception is thrown when a PlayerAudience-Client tries to connect using HTTP, TLS 1.1 or other "outdated" protocols.
    • The Exception is non-critical for the server, the PlayerAudience-Client still has to connect via HTTPS
  • The website looks broken or is not working correctly!
    • A big part of the website's communication is handled through JavaScript - Any add-ons or extensions blocking JavaScript need to be disabled to play the game.

If you have any problems, please write us an issue, we will be happy to help you.