{"id":38275754,"url":"https://github.com/guicybercode/bookish-3d-viewer","last_synced_at":"2026-01-17T01:53:17.551Z","repository":{"id":323505588,"uuid":"1093511891","full_name":"guicybercode/bookish-3d-viewer","owner":"guicybercode","description":"A retro CAD-style 3D viewer application built in Rust, featuring an authentic 80s/90s aesthetic with wireframe and flat shading modes. This application supports viewing OBJ 3D models and 2D images (PNG, JPG) with a nostalgic green/amber color palette reminiscent of early CAD systems.","archived":false,"fork":false,"pushed_at":"2025-11-10T14:08:44.000Z","size":64768,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-10T15:25:11.405Z","etag":null,"topics":["2d","3d","80s","cad","retro","rust","rustc"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guicybercode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-10T13:26:42.000Z","updated_at":"2025-11-10T14:08:48.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/guicybercode/bookish-3d-viewer","commit_stats":null,"previous_names":["guicybercode/bookish-3d-viewer"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/guicybercode/bookish-3d-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicybercode%2Fbookish-3d-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicybercode%2Fbookish-3d-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicybercode%2Fbookish-3d-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicybercode%2Fbookish-3d-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guicybercode","download_url":"https://codeload.github.com/guicybercode/bookish-3d-viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guicybercode%2Fbookish-3d-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28491724,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T00:50:05.742Z","status":"ssl_error","status_checked_at":"2026-01-17T00:43:11.982Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["2d","3d","80s","cad","retro","rust","rustc"],"created_at":"2026-01-17T01:53:17.472Z","updated_at":"2026-01-17T01:53:17.539Z","avatar_url":"https://github.com/guicybercode.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bookish 3D Viewer\n\nA retro CAD-style 3D viewer application built in Rust, featuring an authentic 80s/90s aesthetic with wireframe and flat shading modes. This application supports viewing OBJ 3D models and 2D images (PNG, JPG, BMP, GIF, WebP) with a nostalgic green/amber color palette reminiscent of early CAD systems.\n\n## Features\n\n- **3D Model Viewing**: Load and display OBJ format 3D models with smooth rendering\n- **Image Support**: View images as textures on 3D planes or in 2D viewer mode\n  - Supported formats: PNG, JPG, JPEG, BMP, GIF, WebP\n- **Retro Visual Style**: Authentic 80s/90s CAD aesthetic with:\n  - Green wireframe mode (#00FF00)\n  - Amber flat shading mode (#FFBF00)\n  - Black background for that classic terminal look\n  - Customizable colors via configuration\n- **Interactive Camera Controls**: \n  - Mouse-based rotation, panning, and zooming\n  - Keyboard shortcuts for precise control\n  - Configurable sensitivity settings\n- **Multiple Rendering Modes**: Toggle between wireframe and flat shading\n- **Configuration System**: Persistent settings with TOML configuration file\n- **Model Information**: Display detailed statistics about loaded models\n- **Recent Files**: Track recently opened files\n- **Simple Menu System**: Access credits, controls, and information\n\n## Installation\n\n### Prerequisites\n\n- Rust 1.70 or later (install from [rustup.rs](https://rustup.rs/))\n- A graphics card with Vulkan, Metal, DirectX 12, or WebGPU support\n\n### Building from Source\n\n```bash\ngit clone https://github.com/guicybercode/bookish-3d-viewer.git\ncd bookish-3d-viewer\ncargo build --release\n```\n\nThe executable will be located at `target/release/bookish-3d-viewer` (or `target/release/bookish-3d-viewer.exe` on Windows).\n\n### Running\n\n```bash\ncargo run --release\n```\n\nOr with a file:\n\n```bash\ncargo run --release -- path/to/model.obj\ncargo run --release -- path/to/image.png\n```\n\n## Usage\n\n### Loading Files\n\n- **Command Line**: Pass the file path as an argument when launching the application\n- **Drag and Drop**: Drag OBJ files or images (PNG, JPG, BMP, GIF, WebP) directly into the window\n\n### Controls\n\n#### Mouse Controls\n\n- **Left Click + Drag**: Rotate the camera around the model\n- **Right Click + Drag**: Pan the view\n- **Scroll Wheel**: Zoom in/out\n\n#### Keyboard Shortcuts\n\n- **R**: Reset camera to default position\n- **W**: Toggle wireframe rendering mode\n- **F**: Toggle flat shading mode\n- **Arrow Keys**: Rotate view (Up/Down/Left/Right)\n- **+ / =**: Zoom in\n- **-**: Zoom out\n- **M / ESC**: Toggle menu visibility\n- **I**: Toggle image mode (when an image is loaded)\n- **H**: Toggle model information display\n- **S**: Save current configuration\n\n## Configuration\n\nThe application automatically creates a configuration file at:\n- **Linux**: `~/.config/bookish-3d-viewer/config.toml`\n- **macOS**: `~/Library/Application Support/bookish-3d-viewer/config.toml`\n- **Windows**: `%APPDATA%\\bookish-3d-viewer\\config.toml`\n\nYou can customize:\n- Wireframe color\n- Flat shading color\n- Background color\n- Camera sensitivity\n- Zoom sensitivity\n- Pan sensitivity\n- Default field of view\n- Recent files list\n\n## Technical Details\n\n### Architecture\n\nThe application is built using modern Rust graphics libraries:\n\n- **wgpu**: Cross-platform graphics API abstraction (Vulkan/Metal/DX12/WebGPU)\n- **winit**: Window management and event handling\n- **glam**: Fast math library for 3D transformations\n- **tobj**: OBJ file format parser\n- **image**: Image loading and processing\n- **serde/toml**: Configuration file management\n- **dirs**: Cross-platform directory handling\n\n### Project Structure\n\n```\nbookish-3d-viewer/\n├── Cargo.toml          # Project dependencies and metadata\n├── README.md           # This file\n├── .gitignore          # Git ignore rules\n└── src/\n    ├── main.rs         # Application entry point and event loop\n    ├── renderer.rs     # WGPU rendering pipeline and shader management\n    ├── camera.rs        # Arcball camera implementation\n    ├── model.rs         # OBJ model loading and vertex processing\n    ├── model_info.rs    # Model statistics and information\n    ├── image_viewer.rs  # Image loading and texture management\n    ├── menu.rs          # Menu system and UI overlay\n    ├── config.rs        # Configuration management\n    ├── error.rs         # Error handling types\n    ├── utils.rs         # Utility functions for math and color conversion\n    └── shaders/\n        ├── wireframe.wgsl  # Wireframe rendering shader\n        ├── flat.wgsl       # Flat shading shader\n        └── image.wgsl      # Image texture shader\n```\n\n### Rendering Pipeline\n\nThe application uses three distinct rendering pipelines:\n\n1. **Wireframe Pipeline**: Renders models as line primitives with customizable color\n2. **Flat Shading Pipeline**: Renders models with flat faces and simple lighting using customizable colors\n3. **Image Pipeline**: Renders images as textures on 3D planes with proper UV mapping\n\n### Camera System\n\nThe camera implements an arcball/orbit control system:\n- Spherical coordinate system for smooth rotation\n- Perspective projection with configurable FOV\n- Distance-based zooming\n- Pan support for precise positioning\n- Configurable sensitivity for all controls\n\n## Supported File Formats\n\n- **3D Models**: OBJ (.obj)\n- **Images**: PNG (.png), JPEG (.jpg, .jpeg), BMP (.bmp), GIF (.gif), WebP (.webp)\n\n## Performance\n\nThe application is optimized for smooth 60 FPS rendering:\n- Efficient vertex buffer management\n- Minimal draw calls\n- Hardware-accelerated rendering via wgpu\n- Proper depth testing and culling\n- Buffer reuse to minimize allocations\n\n## Platform Support\n\n- **Windows**: DirectX 12 or Vulkan\n- **macOS**: Metal\n- **Linux**: Vulkan\n- **Web**: WebGPU (future support)\n\n## Recent Improvements\n\n- ✅ Configuration system with persistent settings\n- ✅ Model information display\n- ✅ Support for more image formats (BMP, GIF, WebP)\n- ✅ Recent files tracking\n- ✅ Configurable camera sensitivity\n- ✅ Better error handling\n- ✅ Improved code organization\n- ✅ Enhanced menu with model info\n\n## Contributing\n\nContributions are welcome! Please feel free to submit issues or pull requests.\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Credits\n\n**Made by**: [guicybercode](https://github.com/guicybercode)\n\n**Repository**: [https://github.com/guicybercode/bookish-3d-viewer](https://github.com/guicybercode/bookish-3d-viewer)\n\n### Acknowledgments\n\nBuilt with love for retro computing aesthetics and modern Rust performance.\n\n---\n\n**하나님은 나의 빛이요, 나의 구원이시니 내가 누구를 두려워하랴**  \n*God is my light and my salvation—whom shall I fear.*  \n*(Psalm 27:1)*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguicybercode%2Fbookish-3d-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguicybercode%2Fbookish-3d-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguicybercode%2Fbookish-3d-viewer/lists"}