termgl


Nametermgl JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
SummaryTerminal-based 2D & 3D graphics library.
upload_time2024-11-16 19:28:51
maintainerNone
docs_urlNone
authorWojciech Graj
requires_python>=3.11
licenseMIT 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.
keywords graphics terminal render rendering text ascii
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "termgl",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "graphics, terminal, render, rendering, text, ascii",
    "author": "Wojciech Graj",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/05/07/250b1adc51412dde74356e684b14ec387262512538d941fe0547c86dd317/termgl-0.2.1.tar.gz",
    "platform": null,
    "description": "# TermGL\n\nA terminal-based graphics library for 2D and 3D graphics.\n\nFeatures:\n- Windows & *NIX support\n- C99 compliant without external dependencies\n- Custom vertex and pixel shaders\n- Affine texture mapping\n- 24 bit RGB\n- Indexed color mode: 16 Background colors, 16 foreground colors, bold and underline\n- Non-blocking input from terminal\n- Mouse tracking\n\n![CUBE](https://w-graj.net/images/termgl/textures.gif)\n\n## Installation\n\nPackage can be found on [PyPI](https://pypi.org/project/termgl/) and can be installed using pip:\n```\npip install termgl\n```\n\n## Documentation\n\nThe best way to learn to use TermGL is to read the tutorial [here](./TUTORIAL.md).\n\nAdditionally, documentation of all public members of TermGL can be found [here](https://wojciech-graj.github.io/pyTermGL/).\n\n## Demo\n\nA variety of demos can be found in the `demo` directory. To run the demo utility, simply `python demo`.\n\nAvailable demos and TermGL features used:\n1. Utah Teapot\\\nRenders a rotating 3D Utah Teapot.\n\t- Backface culling\n\t- Z buffering\n\t- Double-width characters\n\t- 3D rendering\n\t- Custom shaders\n2. Color Palette\\\nRenders a palette of various text colors and styles.\n\t- Colors & Modifiers\n3. Mandelbrot\\\nRenders an infinitely zooming-in Mandelbrot set.\n\t- Point rendering\n4. Realtime Keyboard\\\nDisplays keyboard input in realtime.\n\t- Text rendering\n\t- Realtime keyboard input\n5. Textured Cube\\\nRenders a texture-mapped cube.\n\t- Backface culling\n\t- Z buffering\n\t- Double-width characters\n\t- 3D rendering\n\t- Shaders\n\t- Texture mapping\n6. RGB\\\nRenders overlapping red, green, and blue circles.\n\t- 24 bit RGB\n\t- Text rendering\n7. Mouse\\\nDisplays mouse position and button state.\n\t- Mouse tracking\n\t- Text rendering\n\n### Gallery\n\n![LOGO](https://w-graj.net/images/termgl/logo.gif)\n\n![CANYON](https://w-graj.net/images/termgl/canyon.gif)\n",
    "bugtrack_url": null,
    "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. ",
    "summary": "Terminal-based 2D & 3D graphics library.",
    "version": "0.2.1",
    "project_urls": {
        "Repository": "https://github.com/wojciech-graj/pyTermGL"
    },
    "split_keywords": [
        "graphics",
        " terminal",
        " render",
        " rendering",
        " text",
        " ascii"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0507250b1adc51412dde74356e684b14ec387262512538d941fe0547c86dd317",
                "md5": "858dc5b09524332710fd813d06ac5c28",
                "sha256": "73e523300707972096d3429fc0075be32c2e32958f887cb101a9a62dc73f0d77"
            },
            "downloads": -1,
            "filename": "termgl-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "858dc5b09524332710fd813d06ac5c28",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 28545,
            "upload_time": "2024-11-16T19:28:51",
            "upload_time_iso_8601": "2024-11-16T19:28:51.717293Z",
            "url": "https://files.pythonhosted.org/packages/05/07/250b1adc51412dde74356e684b14ec387262512538d941fe0547c86dd317/termgl-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-16 19:28:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "wojciech-graj",
    "github_project": "pyTermGL",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "termgl"
}
        
Elapsed time: 0.40245s