GvRNG

The old Guido van Robot code with a new Kivy-based frontend

This release should be considered a working test version, not yet ready for deployment

The project is released under the GPL v3 license.

The GPL v3 license is a strong copyleft license that allows you to freely use, modify, and distribute the software, provided that any derivative works or distributed copies are also licensed under GPL v3. It requires you to provide the source code or access to it, include the license text, and keep any notices intact. The license also addresses issues like tivoization, patent grants, and compatibility with other licenses, ensuring that the freedoms to use and modify the software are preserved and protected for all users.

Importantly, GPL v3 prohibits the code from being incorporated into closed-source or proprietary software, meaning you cannot use or distribute it in software that is not also licensed under GPL v3.

Current development screenshot:

Installing from source on Ubuntu 24.04 / 26.04

• Obtain the source code:
• Option A (Git): Clone the repository and switch to the Kivy branch: bash git clone -b Kivy https://codeberg.org/childsplay/GvR cd GvR
• Option B (Tarball): Download the source package from SourceForge.
• Install system dependencies:
• python3-dev, python3-venv (Python >= 3.12)
• build-essential libgl1-mesa-dev libavcodec-dev libsdl2-dev
• Set up a Python >= 3.12 virtual environment and activate it.
• Install dependencies: pip install -r requirements.txt

Installing on macOS (Sonoma)

• As macOS no longer ships Python, you need to install it first. We support Python up to v3.12.10. You can download the installer here: https://www.python.org/ftp/python/3.12.10/python-3.12.10-macos11.pkg
• Let it unpack and choose the default answers in the installer.
• Close the installer.
• Download the GvRNG source package: https://sourceforge.net/projects/gvr/files/GvRNG/gvrng-5.0-dist.tar.gz/download
• Set up a Python virtual environment:
• Start a terminal.
• Unpack the source package in the terminal: tar -xf gvrng-5.0-dist.tar.gz
• Go into the unpacked folder: cd gvrng-5.0-dist
• Create a Python virtual environment: python3.12 -m venv .venv3.12
• Activate the virtual environment: source .venv3.12/bin/activate
• Upgrade pip: python3.12 -m pip install --upgrade pip
• Install dependencies: python3.12 -m pip install -r requirements.txt
• To run GvRNG:
• If starting a new terminal, navigate to the folder (cd gvrng-5.0-dist) and activate the virtual environment (source .venv3.12/bin/activate).
• Start GvRNG: python3 gvrng.py
• If you are on a high-DPI screen, you might want to edit the configuration file (see below).

GvRNG configuration file

We use a configuration file to configure certain aspects of the GvRNG program. To generate a configuration file, you need to start GvRNG at least once.

The location of the file is: ~/.childsplay.rc/gvrng.cfg (in your home directory)

Important: If you have a high-DPI screen, set scale_factor = 2 inside the configuration file:

scale_factor = 2

GvRNG logging

We keep logs in: ~/.childsplay.rc/logs (in your home directory)

There will be logs from both the GvRNG program and the Kivy library. If you have any issues with the program or want to see what is going on, the gvr.log file is the one you need. If you want to report a bug, always include the latest gvr.log and kivy.log files.