https://github.com/ecumene/rust-sloth

A 3D software rasterizer... for the terminal!
https://github.com/ecumene/rust-sloth

cli cli-app computer-graphics graphics graphics-3d hacktoberfest rust

Last synced: 7 days ago
JSON representation

A 3D software rasterizer... for the terminal!

• Host: GitHub
• URL: https://github.com/ecumene/rust-sloth
• Owner: ecumene
• License: isc
• Created: 2019-03-11T03:16:47.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-28T02:42:10.000Z (10 months ago)
• Last Synced: 2024-07-10T22:29:37.062Z (4 months ago)
• Topics: cli, cli-app, computer-graphics, graphics, graphics-3d, hacktoberfest, rust
• Language: Rust
• Homepage:
• Size: 45.6 MB
• Stars: 760
• Watchers: 12
• Forks: 20
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# sloth - A one-of-a-kind Rust 3D Renderer for the CLI

![pikachu](models/demo/pikachu.gif)

  

A one-of-a-kind command line 3D software rasterizer made with termion, tobj, and nalgebra. Currently it 

supports OBJ file formats without textures. It also supports OBJ file formats with vertex colors.

[Javascript Export Demonstration](http://ecumene.xyz/sloth-demo)

## Getting Started / Uses

---

Here's a few really simple commands for you to get started.

You can replace `sloth ` with `cargo run --release -- ` anywhere

#### Render pikachu

```

sloth models/Pikachu.obj

```

#### For multiple models:   

```

sloth "models/suzy.obj models/suzy.obj"

```

#### You can also generate a static image:

```

sloth models/Pikachu.obj image -w  -h 

```

#### You can also generate a portable Javascript render like this:

```

sloth models/Pikachu.obj image -j  -w  -h  > src-webify/data.js

```

Thank you, contributors!

---

[Maxgy](https://github.com/Maxgy) – Rustfmt lint

[donbright](https://github.com/donbright) – STL model loading added, Rustfmt lint

[sophiajt](https://github.com/sophiajt) – Crossterm port