Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Ulto85/amongGX/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Before you can run amongGX you need two things on your machine:
RequirementMinimum VersionNotes
Python3.7+Any 3.7, 3.8, 3.9, 3.10, or 3.11 release works
pipbundled with PythonUsed to install PyQt5 and PyQtWebEngine
Confirm both are available by running: 
python --version
pip --version
amongGX relies on Qt’s windowing system to display the browser. A graphical desktop environment is required — Qt cannot run in a headless or server-only environment. If you are on a headless Linux machine (e.g., a VPS or CI runner), you will need a virtual framebuffer such as Xvfb or a full desktop session.

​
Python Dependencies

browser.py imports from three PyQt5 packages: 
from PyQt5.QtCore import *
from PyQt5.QtWidgets import *
from PyQt5.QtWebEngineWidgets import *
These map to two pip packages:
pip packageWhat it provides
PyQt5QtCore, QtWidgets, and the rest of the Qt bindings
PyQtWebEngineQtWebEngineWidgets — the Chromium-backed web view

​
Installing the Dependencies

pip install PyQt5 PyQtWebEngine

​
Getting the Source Code

amongGX is a single-file application — everything lives in browser.py. 
git clone https://github.com/Ulto85/amongGX.git
cd amongGX

​
Step-by-Step Installation

1

Verify Python and pip

Open a terminal and confirm you have Python 3.7+ and pip:
python --version
pip --version
If Python is not installed, download it from python.org and ensure the “Add Python to PATH” option is checked during the Windows installer.
2

(Optional) Create a virtual environment

Using a virtual environment keeps your global Python install clean:
python -m venv venv
source venv/bin/activate      # Windows: venv\Scripts\activate
3

Install PyQt5 and PyQtWebEngine

pip install PyQt5 PyQtWebEngine
This pulls in the Qt bindings and the Chromium-backed QtWebEngineWidgets module that powers the browser view.
4

Clone or download the repository

git clone https://github.com/Ulto85/amongGX.git
cd amongGX
If you don’t use Git, download browser.py directly from the repository and save it to a local folder.
5

Run the browser

python browser.py
The Among Us-themed browser window should appear and navigate to the default home page.

​
Auto-Installing via requirements.txt

The source file contains a commented-out one-liner that can install dependencies automatically: 
#os.system('pip install -r requirements.txt')
If you create a requirements.txt in the same directory with the following content: 
PyQt5
PyQtWebEngine
…you can uncomment that line and browser.py will call pip itself on every launch. This is handy when sharing the project with people who may not have the dependencies installed yet. Keep in mind it adds a small startup delay and is not recommended for production use.

​
Troubleshooting

ProblemLikely CauseFix
ModuleNotFoundError: No module named 'PyQt5'PyQt5 not installed in the active environmentRun pip install PyQt5 PyQtWebEngine
ModuleNotFoundError: No module named 'PyQt5.QtWebEngineWidgets'PyQtWebEngine missingRun pip install PyQtWebEngine
Window does not appear / crashes on launchNo display server availableEnsure a desktop session or virtual framebuffer is running
python: command not foundPython not on PATHUse python3 instead, or fix your PATH

Build docs developers (and LLMs) love

Get started for freeTalk to us