nflsilva / simple-3d-viewer

A very simple 3D mesh renderer using OpenGL, written in C.

simple-3d-viewer

A very simple 3D mesh renderer written in C.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Build
3. Usage

About The Project

S3V is very simple 3D Viewer written in C. It supports single mesh Wavefront .obj files.

Built With

This section should list any major components used in this project. All the code should be included in this repo, under the dependencies folder.

• GLFW
• OpenGL
• glad, an OpenGL loader
• Nuklear, an immediate mode ui rendering library.

Getting Started

Prerequisites

Compiling S3V requires gcc and cmake.

1. Install the basic tools

• Arch Linux

  # pacman -S gcc cmake

Compiling

1. Clone the repo

   $ git clone https://github.com/nflsilva/s3v.git

2. Navigate into s3v directory and build the application

   $ cd s3v
   $ mkdir build
   $ cd build
   $ cmake ..
   $ make

Usage

Simply run

$ ./s3v

and then, select File->Open Model and select a .obj file. Use the right-mouse button to rotate the model.

What's next

This renderer needs way more features. These are some of the planned ones in no particular order:

• Support multiple mesh models;
• Support materials and textures;
• Support negative index Wavefont files;
• Support multiple platforms;
• Support model animations;
• Support for on the fly shader loading;
• Improve file loading performance.