{"id":21095031,"url":"https://github.com/zoroxide/nut-graphics-engine","last_synced_at":"2025-03-14T07:11:35.500Z","repository":{"id":260949664,"uuid":"882799718","full_name":"zoroxide/nut-graphics-engine","owner":"zoroxide","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-09T15:52:22.000Z","size":6457,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-21T01:43:00.511Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","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/zoroxide.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}},"created_at":"2024-11-03T19:40:17.000Z","updated_at":"2024-11-09T15:52:25.000Z","dependencies_parsed_at":"2024-11-03T20:37:36.893Z","dependency_job_id":null,"html_url":"https://github.com/zoroxide/nut-graphics-engine","commit_stats":null,"previous_names":["zoroxide/nut-graphics-engine"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoroxide%2Fnut-graphics-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoroxide%2Fnut-graphics-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoroxide%2Fnut-graphics-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoroxide%2Fnut-graphics-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zoroxide","download_url":"https://codeload.github.com/zoroxide/nut-graphics-engine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243538136,"owners_count":20307104,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-19T22:22:05.260Z","updated_at":"2025-03-14T07:11:35.464Z","avatar_url":"https://github.com/zoroxide.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Nut Graphics Engine\n\n## Description\n\nThe Nut Engine is a lightweight and modular graphics engine designed to facilitate the development of 3D applications using OpenGL. It abstracts the complexity of OpenGL setup and rendering, providing a simple interface for loading models, shaders, and rendering scenes. The engine is built with C++ and utilizes GLFW for window management and GLM for mathematics.\n\n## Features\n\n- **Model Loading**: Supports loading and rendering 3D models.\n- **Shader Management**: Allows for easy integration and management of vertex and fragment shaders.\n- **Camera Control**: Implements basic camera movements and view transformations.\n- **OpenGL Integration**: Simplifies OpenGL initialization and rendering processes.\n- **Extensible Architecture**: Easily add new features and extend functionality.\n\n## Project Structure\n\n```\nnut/\n├── build/                   # Directory for build files\n├── external/                # External libraries\n│   ├── glfw/                # GLFW library\n│   └── glad/                # GLAD library\n├── src/                     # Source files\n│   ├── Shader.cpp           # Shader class implementation\n│   ├── Model.cpp            # Model class implementation\n│   ├── Renderer.cpp         # Renderer class implementation\n│   └── Engine.cpp           # Main engine implementation\n├── shaders/                 # Shader files\n│   ├── vertex_shader.glsl   # Vertex shader source\n│   └── fragment_shader.glsl # Fragment shader source\n├── CMakeLists.txt           # CMake build configuration\n└── main.cpp                 # Entry point for the application\n```\n\n## Requirements\n\n- C++17\n- CMake (version 3.10 or higher)\n- GLFW (included in external folder)\n- GLAD (included in external folder)\n- OpenGL \n\n## Building the Project\n\nTo build the project, follow these steps:\n\n1. **Clone the repository** or download the project files.\n2. Open a terminal and navigate to the project directory.\n3. Create a build directory:\n   ```bash\n   mkdir build\n   ```\n4. Compile the project:\n   ```bash\n   make\n   ```\n5. Run the application:\n   ```bash\n   build/app\n   ```\n\n## Usage\n\nTo use the engine, create an instance of the `Engine` class and call the `render` method with the path to the model you want to load. For example:\n\n```cpp\nEngine engine;\nengine.render(\"path/to/your/model.obj\");\n```\n\n## Contributing\n\nContributions are welcome! If you have suggestions or improvements, please feel free to open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoroxide%2Fnut-graphics-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzoroxide%2Fnut-graphics-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoroxide%2Fnut-graphics-engine/lists"}