Metadata-Version: 2.1
Name: termgl
Version: 0.2.0
Summary: Terminal-based 2D & 3D graphics library.
Author: Wojciech Graj
License: MIT License
        
        Copyright (c) 2022-2024 Wojciech Graj
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/wojciech-graj/pyTermGL
Keywords: graphics,terminal,render,rendering,text,ascii
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Multimedia :: Graphics :: 3D Rendering
Classifier: Topic :: Terminals
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Cython
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.25
Provides-Extra: dev
Requires-Dist: pdoc; extra == "dev"
Requires-Dist: pylsp-mypy; extra == "dev"
Requires-Dist: pylsp-rope; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: python-lsp-isort; extra == "dev"
Requires-Dist: python-lsp-server[all]; extra == "dev"

# TermGL

A terminal-based graphics library for 2D and 3D graphics.

Features:
- Windows & *NIX support
- C99 compliant without external dependencies
- Custom vertex and pixel shaders
- Affine texture mapping
- 24 bit RGB
- Indexed color mode: 16 Background colors, 16 foreground colors, bold and underline
- Non-blocking input from terminal
- Mouse tracking

![CUBE](https://w-graj.net/images/termgl/textures.gif)

## Installation

Package can be found on [PyPI](https://pypi.org/project/termgl/) and can be installed using pip:
```
pip install termgl
```

## Documentation

The best way to learn to use TermGL is to read the tutorial [here](./TUTORIAL.md).

Additionally, documentation of all public members of TermGL can be found [here](https://wojciech-graj.github.io/pyTermGL/).

## Demo

A variety of demos can be found in the `demo` directory. To run the demo utility, simply `python demo`.

Available demos and TermGL features used:
1. Utah Teapot\
Renders a rotating 3D Utah Teapot.
	- Backface culling
	- Z buffering
	- Double-width characters
	- 3D rendering
	- Custom shaders
2. Color Palette\
Renders a palette of various text colors and styles.
	- Colors & Modifiers
3. Mandelbrot\
Renders an infinitely zooming-in Mandelbrot set.
	- Point rendering
4. Realtime Keyboard\
Displays keyboard input in realtime.
	- Text rendering
	- Realtime keyboard input
5. Textured Cube\
Renders a texture-mapped cube.
	- Backface culling
	- Z buffering
	- Double-width characters
	- 3D rendering
	- Shaders
	- Texture mapping
6. RGB\
Renders overlapping red, green, and blue circles.
	- 24 bit RGB
	- Text rendering
7. Mouse\
Displays mouse position and button state.
	- Mouse tracking
	- Text rendering

### Gallery

![LOGO](https://w-graj.net/images/termgl/logo.gif)

![CANYON](https://w-graj.net/images/termgl/canyon.gif)
