tt3de 0.1.2

TT3DE: Tiny Textual 3D Engine

TinyTiny 3D Engine

A minimalistic 2D/3D engine implemented in Rust and bound to Python, designed to render 3D objects using ASCII art.

Features

• Rendering Primitives: Supports points, lines, and triangles in both 2D and 3D contexts.
• ASCII Output: Renders 3D scenes in a charming ASCII art style.
• Color Shading Support: Renders with RGB colors.
• Materials: Supports 14 materials, including:
  • Texture Mapping: Supports textures up to 256x256 pixels.
  • Double Raster: Allows the use of 2 colors per ASCII character (background and foreground).
  • Perlin Noise: Basic Perlin noise mapped texture.

Recommended Terminals :

Terminal	Windows	macOS	Linux
wez Terminal	:star: Fastest rendering accross all terms
tabby	:star: Runs ok, struggle at big resolutions
default Windows Terminal	:x: Can't keep up with the rendering
VScode terminal	:x: Does not even works	:x: Can't keep up with rendering	:x:
gostty		:star: Perfect!	:star: Perfect, assuming you have your graphics drivers installed
kitty		Almost perfect, start to slow down at HighRes	untested
iTerm/iTerm2		Won't keep up with high refresh rate (>10fps)

Setting Up the Development Version

To set up a development version of this engine:

1. Clone this repository:

   git clone <repo_url>
   

2. If you have Poetry, run:

   poetry install --with dev --no-root
   

   This will set up the dependencies.

3. If you don't have Poetry, follow these steps:

   python -m venv .venv
   source .venv/bin/activate
   python -m pip install poetry
   # Now you have Poetry in the virtual environment
   poetry install
   

4. Compile the Rust version locally:

   poetry run maturin develop --profile release
   

5. Check the demo:

   PYTHONPATH=python poetry run python demos/3d/some_models.py
   

6. Run the Rust unit tests:

   cargo test
   

7. Run the Python unit tests:

   poetry run pytest
   

Tips for Python Path in VSCode

Due to the mix of Python and Rust in this project, the Python code is located in the python folder. More information can be found here.

In launch.json for VSCode:

"env": {"PYTHONPATH": "${workspaceFolder}/python"}

In settings.json:

{
    "python.analysis.extraPaths": [
        "python"
    ]
}

Known Issues

• Many...