Ventris ReadMe - by 7amithorn (info@usthreeink.com)
Copyright 2021 - 2026 Us Three Enterprises

Thank you for choosing Ventris, a (Micro)Python graphical library for Casio (and beyond). This ReadMe is a basic guide to installing and using Ventris on your system.

~ Installation ~

To install, copy the ventris folder into the base folder from which your version(s) of Python work. For example, for the Casio fx-CG50/Graph 90, the ventris folder would go into ROOT. If your system is not a Casio, you'll need PolyPyNet (https://tipla.net/a2620335) installed (not in a containing folder) in the ventris folder. If you cannot put the ventris files into a folder, simply copy the folder's contents into the base folder.

Note that installing Ventris for the Casio fx-CG50/Graph 90 enables it to be used with PythonExtra (https://www.planet-casio.com/Fr/forums/topic17202-1-beta-pythonextra.html), if it's installed.

~ Use ~

Simply import ventris modules as if they were any other modules on your system. As a general note, import allbase.py for general basic capabilities. It automatically detects your system and enables the correct capabilites.
Documentation will eventually be forthcoming; in the meantime, read the docstrings and check out the examples in the vexample folder.

~ Modules ~

In the ventris proper:
allbase.py - used for basic functions; selects the right base.py file
base.py - used for basic drawing functions
calcs.py - used for calculations for drawing
colors.py - used for colors and color conversions
gbase.py - used for basic drawing functions in PythonExtra
gradient.py - used for drawing gradients
gstats.py - used for basic graphic objects (e.g. text)
highdim.py - used to depict objects in higher dimensions (e.g. 2.5D, 3D) (adapted; see below)
img.py - used for image drawing (adapted; see below)
ntrface.py - used for various higher-level graphic objects; generally, useful stuff from other projects feature-creeps into here
sprites.py - used for highly rudimentary sprites (depreciated; use gstats and img instead)
strimg.py - used for simple image drawing (preliminarily depreciated; may still be useful later, so not removed)
timing.py - used for waiting functions, time formatting, and clock objects

In the vexamples:
click.py - a complex one-screen interface demo
crepos.py - holds graphic objects for click
cpanels.py - holds the texts for the paneled text bar in click
cube.py - demonstrates a rotating 3D cube (adapted; see below)
fall.py - an infinitely falling animation
france.py - demonstrates strimg capabilites
potion.py - draws a potion
scctrfig.py - scatters a bunch of drawn objects on the screen
snow.py - covers the screen with snowfall

~ Credits ~

Ventris was coded on a fx-CG50 in my free time, with a few edits on a PC. You can visit me at my website: usthreeink.com.
These code sources were adapted and used throughout Ventris:

limg project, Mibi88 (color conversion) (Planet Casio, https://www.planet-casio.com/Fr/forums/topic17290-last-the-limg-project-les-images-avec-des-couleurs-rgb565.html)
Module Graphique Python, Zecter (some drawing functions) (Planet Casio, https://www.planet-casio.com/Fr/programmes/programme4264-1-module-graphique-python-zecter-utilitaires-graphisme.html)
3D Pytho, Zecter (most of highdim.py and cube.py) (Planet Casio, https://www.planet-casio.com/Fr/programmes/programme4265-1-3d-python-zecter-utilitaires-graphisme.html)
img2calc, TIPlanet (img.py, effectively) (https://tiplanet.org/forum/img2calc.php)
forum posting, critor (formulae.getSBR()) (Planet Casio, link is unknown)

~ Licensing (GPL v3) ~

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this library. If not, see https://www.gnu.org/licenses/.