vgframework

KO | EN

gitlite — search

#hacktoberfest #react #ai #golang #linux #macos #java #awesome #cli #vue #pytorch #mcp #ios #open-source

(★ 73)

A pet game engine for fun, modern graphics APIs, and fast iteration.

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

- - ARM64EC_MSVC_DX12_Debug.yml
  - ARM64EC_MSVC_DX12_Development.yml
  - ARM64EC_MSVC_DX12_Final.yml
  - ARM64EC_MSVC_DX12_Release.yml
  - ARM64EC_MSVC_Vulkan_Debug.yml
  - ARM64EC_MSVC_Vulkan_Development.yml
  - ARM64EC_MSVC_Vulkan_Final.yml
  - ARM64EC_MSVC_Vulkan_Release.yml
  - Build_Target_vs2022.yml
  - Build_Version.yml
  - Submit.yml
  - Win64_ClangCL_DX12_Debug.yml
  - Win64_ClangCL_DX12_Development.yml
  - Win64_ClangCL_DX12_Final.yml
  - Win64_ClangCL_DX12_Release.yml
  - Win64_ClangCL_Vulkan_Debug.yml
  - Win64_ClangCL_Vulkan_Development.yml
  - Win64_ClangCL_Vulkan_Final.yml
  - Win64_ClangCL_Vulkan_Release.yml
  - Win64_MSVC_DX12_Debug.yml
  - Win64_MSVC_DX12_Development.yml
  - Win64_MSVC_DX12_Final.yml
  - Win64_MSVC_DX12_Release.yml
  - Win64_MSVC_Vulkan_Debug.yml
  - Win64_MSVC_Vulkan_Development.yml
  - Win64_MSVC_Vulkan_Final.yml
  - Win64_MSVC_Vulkan_Release.yml
- - dxcompiler.dll
  - dxil.dll
- - dxcompiler.dll
  - dxil.dll
- - CanonRF24-70mmf2.8.lens
- - Ball.mat
  - Checker.mat
  - DeadGrass.mat
  - Froppy.mat
  - PBR9x9.mat
  - PerfectMirror.mat
  - TestDecal.mat
- - defaultfloor.fbx
  - unitcube.fbx
  - unitcube.fbx.meta
  - unitplane.fbx
  - unitplane.fbx.meta
  - unitsphere.fbx
  - unitsphere.fbx.meta
- - Asphalt.prefab
  - Banana.prefab
  - BananaBonus.prefab
  - Barrier.prefab
  - Bat.prefab
  - Bench.prefab
  - Benualdo.prefab
  - Billboard.prefab
  - Box_Base.prefab
  - Box_Fract.prefab
  - ChainSaw.prefab
  - Clown.prefab
  - Cone.prefab
  - CosmoDog.prefab
  - Cube.prefab
  - Dec_DeadGrass.prefab
  - EngineStats.prefab
  - FenceWall.prefab
  - FenceWallCorner.prefab
  - Florr_Grass.prefab
  - Football.prefab
  - Froppy.prefab
  - GJ.prefab
  - Goal.prefab
  - GrosCovid.prefab
  - HealthBar.prefab
  - Justin.prefab
  - Katana.prefab
  - KatanaRomeo.prefab
  - Loot_Box.prefab
  - MechaTest.prefab
  - Mirror.prefab
  - Pablo.prefab
  - Parking_Side_3x6.prefab
  - PBR 9x9.prefab
  - PBR.prefab
  - PistoBanana.prefab
  - Player.prefab
  - Player_Ben.prefab
  - PlayerUI.prefab
  - Probes.prefab
  - Road.prefab
  - Road_Cross.prefab
  - Road_Curve.prefab
  - Road_HalfCross.prefab
  - Road_Turn_Inner.prefab
  - Road_Turn_Outer.prefab
  - Road_Turn_Road.prefab
  - RoboATT.prefab
  - RoboATT2M.prefab
  - Romeo.prefab
  - Rubgyball.prefab
  - SideWalkLedge.prefab
  - TestComponent.prefab
  - TrafficLight.prefab
  - VGF_Boy.prefab
- - Aiguelongue.scene
  - BLAStest.scene
  - Empty.scene
  - PBR.scene
  - Soccer.scene
  - TestDrive.scene
  - TestPhysics.scene
- - Black.tga
  - Black.tga.meta
  - Checker.tga
  - Checker.tga.meta
  - Pablo.meta
  - QuestionBox.psd
  - vgframework.tga
  - vgframework.tga.meta
  - White.tga
  - White.tga.meta
- - BLAStest.world
  - Game.world
- - 0.54.6.gif
  - arm64ec.gif
  - buildfailed.png
  - buildsuccess.png
  - clang.gif
  - covidboyicon.png
  - dx12.gif
  - GJ.png
  - GrosCovid.png
  - LLVM.gif
  - logo0.png
  - modules.png
  - msvc.gif
  - newsubmit.png
  - Optick.png
  - ResourceWindow.gif
  - screenshot.png
  - SolutionConfiguration.png
  - SolutionDir.png
  - SolutionPlatformName.png
  - version.png
  - VGF_Boy.png
  - VGF_Boy_BotPP.png
  - vgframework64.png
  - vglogowip.psd
  - vsbuild.png
  - vulkan.gif
  - VulkanSDKinstall.png
  - x64.gif
- modules.drawio
- - .gitignore
  - CHANGELOG.md
  - LICENSE.txt
  - NOTICES.txt
  - README.md
- - .gitignore
  - font.go
  - GenerateIconFontCppHeaders.py
  - go.mod
  - IconsCodicons.cs
  - IconsCodicons.go
  - IconsCodicons.h
  - IconsCodicons.py
  - IconsCodicons.rs
  - IconsFontaudio.cs
  - IconsFontaudio.go
  - IconsFontaudio.h
  - IconsFontaudio.py
  - IconsFontaudio.rs
  - IconsFontAwesome4.cs
  - IconsFontAwesome4.go
  - IconsFontAwesome4.h
  - IconsFontAwesome4.py
  - IconsFontAwesome4.rs
  - IconsFontAwesome5.cs
  - IconsFontAwesome5.go
  - IconsFontAwesome5.h
  - IconsFontAwesome5.py
  - IconsFontAwesome5.rs
  - IconsFontAwesome5Brands.cs
  - IconsFontAwesome5Brands.go
  - IconsFontAwesome5Brands.h
  - IconsFontAwesome5Brands.py
  - IconsFontAwesome5Brands.rs
  - IconsFontAwesome5Pro.cs
  - IconsFontAwesome5Pro.go
  - IconsFontAwesome5Pro.h
  - IconsFontAwesome5Pro.py
  - IconsFontAwesome5Pro.rs
  - IconsFontAwesome5ProBrands.cs
  - IconsFontAwesome5ProBrands.go
  - IconsFontAwesome5ProBrands.h
  - IconsFontAwesome5ProBrands.py
  - IconsFontAwesome5ProBrands.rs
  - IconsFontAwesome6.cs
  - IconsFontAwesome6.go
  - IconsFontAwesome6.h
  - IconsFontAwesome6.py
  - IconsFontAwesome6.rs
  - IconsFontAwesome6Brands.cs
  - IconsFontAwesome6Brands.go
  - IconsFontAwesome6Brands.h
  - IconsFontAwesome6Brands.py
  - IconsFontAwesome6Brands.rs
  - IconsForkAwesome.cs
  - IconsForkAwesome.go
  - IconsForkAwesome.h
  - IconsForkAwesome.py
  - IconsForkAwesome.rs
  - IconsKenney.cs
  - IconsKenney.go
  - IconsKenney.h
  - IconsKenney.py
  - IconsKenney.rs
  - IconsMaterialDesign.cs
  - IconsMaterialDesign.go
  - IconsMaterialDesign.h
  - IconsMaterialDesign.py
  - IconsMaterialDesign.rs
  - IconsMaterialDesignIcons.cs
  - IconsMaterialDesignIcons.go
  - IconsMaterialDesignIcons.h
  - IconsMaterialDesignIcons.py
  - IconsMaterialDesignIcons.rs
  - licence.txt
  - README.md
- - CMakeLists.txt
  - ImGuiFileDialog.cpp
  - ImGuiFileDialog.h
  - ImGuiFileDialogConfig.h
  - LICENSE
  - README.md
- - .editorconfig
  - GraphEditor.cpp
  - GraphEditor.h
  - ImCurveEdit.cpp
  - ImCurveEdit.h
  - ImGradient.cpp
  - ImGradient.h
  - ImGuizmo.cpp
  - ImGuizmo.h
  - ImSequencer.cpp
  - ImSequencer.h
  - ImZoomSlider.h
  - LICENSE
  - Makefile
  - README.md
- - .clang-format
  - .editorconfig
  - .gitattributes
  - .gitignore
  - ContributorAgreement.md
  - Doxyfile
  - LICENSE
  - README.md
  - run_doxygen.bat
  - sonar-project.properties
- - .editorconfig
  - .gitattributes
  - .gitignore
  - CODE_OF_CONDUCT.md
  - Compile.ps1
  - CONTRIBUTING.md
  - Directory.Build.props
  - LICENSE.md
  - NuGet.config
  - README.md
  - RunProcess.ps1
  - RunSample.ps1
  - RunSharpmake.ps1
  - SamplesDef.json
.gitattributes
.gitignore
ASSETS_LICENSE.md
Audio.xml
CHANGELOG.md
editor.exe
Editor.xml
Engine.xml
Game.xml
LICENCE.md
Physics.xml
README.md
Renderer.xml
WinPixEventRuntime.dll

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# VGFramework 0.55
VGFramework is a pet game engine for fun, modern graphics APIs, and fast iteration.

![Demo](https://raw.githubusercontent.com/vimontgames/vgframework/master/doc/img/0.54.6.gif)

# Table of contents
[Build status](#Build-Status)\
[Getting started](#Getting-started)\
[Licence](#Licence)\
[Extern libs](#Extern-libs)\
[Assets](#Assets)\
[Misc](#Misc)

# Build status

| Configuration        | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Debug &nbsp;&nbsp;&nbsp;&nbsp;                                                                                                                                     | Development                                                                                                                                                                                                   | &nbsp;&nbsp;&nbsp; Release &nbsp;&nbsp;&nbsp;                                                                                                                                                         | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Final &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;                                                                                                                             |
|--------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ARM64EC MSVC DX12    | <div align="center">![ARM64EC MSVC DX12 Debug Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_DX12_Debug.yml?branch=master&label=)      </div> | <div align="center">![ARM64EC MSVC DX12 Development Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_DX12_Development.yml?branch=master&label=)      </div> | <div align="center">![ARM64EC MSVC DX12 Release Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_DX12_Release.yml?branch=master&label=)      </div> | <div align="center">![ARM64EC MSVC DX12 Final Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_DX12_Final.yml?branch=master&label=)    </div> |
| ARM64EC MSVC Vulkan  | <div align="center">![ARM64EC MSVC Vulkan Debug Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_Vulkan_Debug.yml?branch=master&label=)  </div> | <div align="center">![ARM64EC MSVC Vulkan Development Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_Vulkan_Development.yml?branch=master&label=)  </div> | <div align="center">![ARM64EC MSVC Vulkan Release Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_Vulkan_Release.yml?branch=master&label=)  </div> | <div align="center">![ARM64EC MSVC Vulkan Final Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/ARM64EC_MSVC_Vulkan_Final.yml?branch=master&label=)</div> |
| Win64 MSVC DX12      | <div align="center">![Win64 MSVC DX12 Debug Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_DX12_Debug.yml?branch=master&label=)          </div> | <div align="center">![Win64 MSVC DX12 Development Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_DX12_Development.yml?branch=master&label=)          </div> | <div align="center">![Win64 MSVC DX12 Release Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_DX12_Release.yml?branch=master&label=)          </div> | <div align="center">![Win64 MSVC DX12 Final Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_DX12_Final.yml?branch=master&label=)        </div> |
| Win64 MSVC Vulkan    | <div align="center">![Win64 MSVC Vulkan Debug Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_Vulkan_Debug.yml?branch=master&label=)      </div> | <div align="center">![Win64 MSVC Vulkan Development Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_Vulkan_Development.yml?branch=master&label=)      </div> | <div align="center">![Win64 MSVC Vulkan Release Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_Vulkan_Release.yml?branch=master&label=)      </div> | <div align="center">![Win64 MSVC Vulkan Final Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_MSVC_Vulkan_Final.yml?branch=master&label=)    </div> |
| Win64 ClangCL DX12   | <div align="center">![Win64 ClangCL DX12 Debug Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_DX12_Debug.yml?branch=master&label=)    </div> | <div align="center">![Win64 ClangCL DX12 Development Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_DX12_Development.yml?branch=master&label=)    </div> | <div align="center">![Win64 ClangCL DX12 Release Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_DX12_Release.yml?branch=master&label=)    </div> | <div align="center">![Win64 MSVC DX12 Final Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_DX12_Final.yml?branch=master&label=)     </div> |
| Win64 ClangCL Vulkan | <div align="center">![Win64 ClangCL Vulkan Debug Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_Vulkan_Debug.yml?branch=master&label=)</div> | <div align="center">![Win64 ClangCL Vulkan Development Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_Vulkan_Development.yml?branch=master&label=)</div> | <div align="center">![Win64 ClangCL Vulkan Release Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_Vulkan_Release.yml?branch=master&label=)</div> | <div align="center">![Win64 MSVC Vulkan Final Status](https://img.shields.io/github/actions/workflow/status/vimontgames/vgframework/Win64_ClangCL_Vulkan_Final.yml?branch=master&label=) </div> |

# Getting started

You have two options depending on whether you want to build from source or use the provided executables:

## Using precompiled binaries (users)

- Run `editor.exe` to launch the editor.
- Run `game.exe` to start the game.

## Building from sources (programmers)

By default, VGFramework uses the precompiled binaries: `editor.exe`, `game.exe`, and the DLLs located in the `bin/` folder.

When you build locally, executable files will be created in your `build/` folder.\
The program will use these locally built files if they are present; otherwise, it will fallback to the precompiled binaries.

### To build from sources:

- Sync the depot.
- Install the required SDKs and configure the environment variables.
- [Generate solution](#Generate-solution) and open it in your favorite development environment.
- Select solution [Configuration](#Solution-Configuration) and [Platform](#Solution-Platform)
- Select the solution folder for [Working Directory](#Working-Directory)
- Build & Run

**Debug**, **Development** and **Release** versions will start with the editor:
Press `F5` to enter game mode and `F11` to maximize game view and press `ESC` to go back Editor mode.

**Final** versions are compiled without the editor, they will start directly in game mode and maximized.

First run might take a few seconds because files are cooking.

## Generate solution

VGFramework is using [Sharpmake](https://github.com/ubisoft/Sharpmake) to generate its solution and projects files for all supported platforms.\

You can generate the solutions using `sharpmake\generates_projects_XXX.bat` where `XXX` is your development environment.

e.g. `sharpmake\generates_projects_Windows.bat` will generate `vgframework_vs2022.sln` with all Windows targets.

| Config                                    | Description                   | Format             | Files
| ----------------------------------------- | ----------------------------- | ------------------ | ------------------------------------
| **generate_projects_Windows.bat**         |  All Windows targets          | Visual Studio 2022 | *.sln; *.vxcproj; *.vcxproj.filters
| **generate_projects_Windows_msvc.bat**    |  MSVC Windows targets only    | Visual Studio 2022 | *.sln; *.vxcproj; *.vcxproj.filters
| **generate_projects_Windows_arm64ec.bat** |  ARM64EC Windows targets only | Visual Studio 2022 | *.sln; *.vxcproj; *.vcxproj.filters
| **generate_projects_macOS.bat**           |  All macOS targets            | XCode              | *.xcodeproj
| **generate_projects_Linux.bat**           |  All Linux                    | Make               | makefile

**generate_projects_Windows_msvc.bat** and **generate_projects_Windows_arm64ec.bat** have been added for convenience if you don't have the Clang compiler installed or you are working on an ARM Surface Pro device.

You can customize the targets to build using the following switchs:

| Name      | Type | Description		            
| --------- | ---- | -----------------------
| `arm64ec` | bool |  Generate ARM64EC platform targets       
| `win64`   | bool |  Generate Win64 platform targets   
| `msvc`    | bool |  Generate MSVC compiler targets       
| `clang`   | bool |  Generate Clang compiler targets  
| `dx12`    | bool |  Generate DX12 API targets       
| `vulkan`  | bool |  Generate Vulkan API targets

e.g.:
```bash
.\bin\windows\Sharpmake.Application.exe "/sources('main.sharpmake.cs') /generateDebugSolution /debugSolutionPath('debug/Windows') /win64(true) /arm64ec(false) /clang(false) /msvc(true) /dx12(true) /vulkan(false)"
```
will generate only the Win64 targets using the MSVC compiler and the DirectX12 API.

## IDE
Recommended IDE is [VS Studio 2022 Community](https://visualstudio.microsoft.com/fr/vs/community/) and project files currently provided are compatible with this version.

However, the engine is currently being ported to other platforms than Windows so ultimately a project generator solution will be used.

To compile the solution you will need the following components if they are not already installed:
- MSVC v143 - VS 2022 C++ x64/x86 build tools (latest)
- C++ ATL for latest v143 build tools (x86 & x64)

You will also need if you want to build the ARM64EC versions:
- MSVC v143 - VS 2022 C++ ARM64/ARM64EC build tools (latest)
- C++ ATL for latest v143 build tools (ARM64/ARM64EC)

![Screenshot](https://raw.githubusercontent.com/vimontgames/vgframework/master/doc/img/vsbuild.png)

### Solution Configuration
Use the 'Configuration' combo to select build configuration:

![Screenshot](https://raw.githubusercontent.com/vimontgames/vgframework/master/doc/img/SolutionConfiguration.png)

| Config      | #define         | Runtime | Optimization | Inlining | Edit & Continue | Assert   
| ----------- | --------------- | ------- | ------------ | -------- | --------------- | -------
| Debug       | `VG_DEBUG`      | /MDd    | /Od          | /Ob0     | Yes             | Yes
| Development | `VG_DEVELOPMENT`| /MD     | /Od          | /Ob0     | Yes             | Yes
| Release     | `VG_RELEASE`    | /MD     | /O2          | /Ob2     | No              | Yes
| Final       | `VG_FINAL`      | /MD     | /O2          | /Ob2     | No              | No

The recommended default configuration is `Development` as it's a good compromise between debugging information, performance and it allow 'Edit & Continue'.

### Solution Platform
Use the 'Platform' combo to select target architecture and graphics API:

![Screenshot](https://raw.githubusercontent.com/vimontgames/vgframework/master/doc/img/SolutionPlatformName.png)

The recommended default solution under Windows is `Win64 MSVC DX12` as it's the primary OS, compiler, and API used by the author.

### Working Directory

Set your working directory to **$(SolutionDir)** so that the program can find data and code.

![Screenshot](https://raw.githubusercontent.com/vimontgames/vgframework/master/doc/img/SolutionDir.png)
 
## Command-line args

| Name   <img width=100/> | Type | Description<img width=360/>													
| ----------------------- | ---- | ------------------------------------------------------------- 
| `attachDebugger`        | bool | MessageBox at application start to let attach a debugger
| `breakOnErrors`         | bool | Break on graphics API errors (*`debugDevice` required*)
| `breakOnWarnings`       | bool | Break on graphics API warnings (*`debugDevice` required*)
| `debugDevice`	          | bool | Enable the graphics API debug layer (*default for `Debug` builds*)
| `editor`                | bool | Enable editor (*default for `Debug` and `Release` builds*)
| `fullscreen`	          | bool | Start application in fullscreen mode instead of windowed	(*default for `Final` builds*)	
| `gamemode`	          | bool | Start application with game view maximized (*default for `Final` builds*)	
| `play`		          | bool | Start application with play mode running	(*default for `Final` builds*)
| `profileStart`          | int  | Profile the 1st N frames
                      
## Keyboard shortcuts

| Name<img width=100/>| Description<img width=360/>		 												
| ------------------- | ------------------------------------------------------------- 
| `A`                 | Toggle snap
| `F`                 | Focus Selection
| `H`                 | Toggle HDR modes (None, HDR10, HDR16)
| `V`                 | Toggle VSync mode (None, 1 VBL, 2 VBL, 3 VBL, 4 VBL)
| `UP`                | Move editor camera forward
| `LEFT`              | Move editor camere left
| `DOWN`              | Move editor camera backward
| `RIGHT`             | Move editor camere right
| `F1`                | Start/stop profiler capture	
| `F2`                | Rename selected Object
| `F6`                | Hot reload shaders
| `F7`                | Hot reload resources				
| `F5`                | Start/Stop Play mode
| `Shift-F5`          | Restart Play mode
| `PAUSE`             | Pause/resume Play mode
| `F11`               | Maximize Game view
| `ESCAPE`            | Exit Play mode and go back to Editor mode
| `DELETE`            | Delete selected objects
| `Ctrl+Mouse Wheel`  | Toggle Translation/Rotation/Scale gizmo
| `Ctrl+D`            | Duplicate selected objects. 
| `Shift+Translate`   | Keep **shift** pressed while moving objects to duplicate objects.
| `Ctrl+S`            | Save
| `Ctrl+U`            | Save Prefab & Update
| `Ctrl+Shift-Q`      | Quit application
| `Alt+Enter`         | Toggle fullscreen

## SDKs

The SDKs are not included with the sources. You need to install them.

| Name <img width=256/>			                                                     | Version <img width=100/>       
| ---------------------------------------------------------------------------------- | -------------  
| [Win10 SDK](https://developer.microsoft.com/fr-fr/windows/downloads/sdk-archive/)  | 10.0.26100.0
| [.Net](https://dotnet.microsoft.com/fr-fr/download/dotnet/6.0)                     | 6.0 
| [Vulkan SDK](https://vulkan.lunarg.com/sdk/home)                                   | 1.3.290.0

Win10 SDK and .Net 6.0 Runtime can be installed directly from Visual Studio in `Tools > Get Tools and Features ...`

.Net 6.0 Runtime is only required for project generation using Sharpmake.

Vulkan SDK is only required to build Vulkan version. **$(VULKAN_SDK)** should point the Vulkan SDK installation dir (e.g., `C:\SDK\Vulkan\1.3.290.0`).

# Extern libs

The external libraries are included with the sources for convenience. Follow the link for details about the licence used.

| Name <img width=256/>			                                                                                             | Version <img width=100/> | License 
| -------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -------------
| [D3D12 Memory Allocator](  https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator                           )    |                          | [MIT](https://github.com/GPUOpen-LibrariesAndSDKs/D3D12MemoryAllocator?tab=MIT-1-ov-file#readme)
| [D3D12 HDR Sample](        https://github.com/microsoft/directx-graphics-samples/tree/master/Samples/Desktop/D3D12HDR )    |                          | [MIT](https://github.com/microsoft/DirectX-Graphics-Samples?tab=MIT-1-ov-file#readme)
| [Dear ImGui - Docking](    https://github.com/ocornut/imgui/commit/3912b3d9a9c1b3f17431aebafd86d2f40ee6e59c           )    | 1.92.5                   | [MIT](https://github.com/ocornut/imgui?tab=MIT-1-ov-file#readme)      
| [DirectX Shader Compiler]( https://github.com/microsoft/DirectXShaderCompiler/releases/tag/v1.8.2505.1                )    | 1.8.2505.1               | [LLVM](https://github.com/microsoft/DirectXShaderCompiler?tab=License-1-ov-file#readme)
| [Dirent](                  https://github.com/tronkko/dirent                                                          )    | 1.23.2                   | [MIT](https://github.com/tronkko/dirent?tab=MIT-1-ov-file#readme)                                               
| [fmt](                     https://github.com/fmtlib/fmt/releases/tag/10.1.1                                          )    | 10.1.1                   | [MIT](https://github.com/fmtlib/fmt?tab=MIT-1-ov-file#readme)
| [FXAA](                    https://github.com/GameTechDev/CMAA2/blob/master/Projects/CMAA2/FXAA/Fxaa3_11.h            )    | 3.11                     | [Apache 2.0](https://github.com/GameTechDev/CMAA2?tab=Apache-2.0-1-ov-file#readme)
| [hlsl++](                  https://github.com/redorav/hlslpp/releases/tag/3.8                                         )    | 3.8                      | [MIT](https://github.com/redorav/hlslpp?tab=MIT-1-ov-file#readme)      
| [IconFont CppHeaders](     https://github.com/juliettef/IconFontCppHeaders                                            )    |                          | [Zlib](https://github.com/juliettef/IconFontCppHeaders?tab=Zlib-1-ov-file#readme)                                          
| [ImGuiFileDialog](         https://github.com/aiekick/ImGuiFileDialog                                                 )    | 0.6.7                    | [MIT](https://github.com/aiekick/ImGuiFileDialog?tab=MIT-1-ov-file#readme)
| [ImGuizmo](                https://github.com/CedricGuillemet/ImGuizmo/releases/tag/1.83                              )    | 1.83                     | [MIT](https://github.com/CedricGuillemet/ImGuizmo?tab=MIT-1-ov-file#readme) 
| [JoltPhysics](             https://github.com/jrouwe/JoltPhysics/releases/tag/v5.0.0                                  )    | 5.0.0                    | [MIT](https://github.com/jrouwe/JoltPhysics?tab=MIT-1-ov-file#readme)       
| [meta_enum_lite](          https://github.com/vimontgames/meta_enum_lite                                              )    | 2.0 (Custom)             | [MIT](https://github.com/vimontgames/meta_enum_lite?tab=License-1-ov-file)         
| [optick](                  https://github.com/bombomby/optick                                                         ) ✨ | 1.3.1                    | [MIT](https://github.com/bombomby/optick?tab=License-1-ov-file)                             
| [px_sched](                https://github.com/pplux/px                                                                )    | f5d3b6e                  | [MIT](https://github.com/pplux/px?tab=MIT-1-ov-file#readme)
| [Sharpmake](               https://github.com/vimontgames/Sharpmake                                                   )    | 0.75.0 (Custom)          | [Apache 2.0](https://github.com/vimontgames/Sharpmake?tab=License-1-ov-file)
| [SoLoud](                  https://github.com/jarikomppa/soloud                                                       )    | August 2024              | [Zlib/libpng](https://github.com/jarikomppa/soloud?tab=License-1-ov-file#readme)
| [stb](                     https://github.com/nothings/stb                                                            )    | 2.30                     | [MIT](https://github.com/nothings/stb?tab=License-1-ov-file#readme)                                    
| [tinyXML2](                https://github.com/leethomason/tinyxml2/releases/tag/10.0.0                                )    | 10.0.0                   | [Zlib](https://github.com/leethomason/tinyxml2?tab=Zlib-1-ov-file#readme)
| [UFBX](                    https://github.com/ufbx/ufbx                                                               )    | 0.14.3                   | [MIT/Public Domain](https://github.com/ufbx/ufbx?tab=License-1-ov-file#readme)                                   
| [Vulkan Memory Allocator]( https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator                          )    | 3.0.1                    | [MIT](https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator?tab=MIT-1-ov-file#readme)
| [WinPixEventRuntime](      https://www.nuget.org/packages/WinPixEventRuntime                                          )    | 1.0.231030001            | [MIT](https://www.nuget.org/packages/WinPixEventRuntime/1.0.240308001/License)

✨ Optick viewer can be tricky to build but you can download the binaries for optick 1.3.1 from https://github.com/bombomby/optick/releases/tag/1.3.1.0 or build them more easily from https://github.com/vimontgames/optick.

# Licence

## Code

The code in `src` folder is licensed under the **MIT License**. Please refer to [LICENCE.md](LICENCE.md) for more details.

External libraries in the `extern` folder use permissive licenses. Please refer to the [Extern libs](#Extern-libs) section for details about the licenses used.

## Data

Most assets are using permissive licenses, while some are restricted to use only within the context of **VGFramework** development. Please refer to the [Assets](#Assets) section for more details about the licenses used.

# Assets

## Assets with usage restrictions

The assets in **the following folders** are licensed under the Creative Commons Non-Commercial (CC BY-NC 4.0) License, with the additional restriction that **they may only be used within the context of VGFramework development**.

Please refer to the [ASSETS_LICENSE.md](ASSETS_LICENSE.md) for more details.

The following assets are provided under permissive licenses. Please follow the provided links for details about those licenses:

### Animations

This project uses character animations generated via [Mixamo](https://www.mixamo.com/#/).

### Fonts

| Name<img width=140/>                                                   | Version<img width=200/> | License 															
| ---------------------------------------------------------------------- | -------------           | ----------------------
| [Font-Awesome]( https://github.com/FortAwesome/Font-Awesome/tree/6.x ) | 6.x                     | [Font Awesome Free License](https://github.com/FortAwesome/Font-Awesome/blob/7.x/LICENSE.txt)    
| [Rowdies](      https://github.com/magictype/rowdy                   ) |                         | [SIL OFL 1.1](https://github.com/magictype/rowdies?tab=OFL-1.1-1-ov-file)
| [RubikMonoOne]( https://fonts.google.com/specimen/Rubik+Mono+One     ) |                         | [SIL OFL 1.1](https://fonts.google.com/specimen/Rubik+Mono+One/license)
| [UbuntuMono](   https://fonts.google.com/specimen/Ubuntu+Mono        ) | 1.0                     | [Ubuntu Font Licence](https://fonts.google.com/specimen/Ubuntu+Mono/license)

### Models

The following models have been modified for engine-compatible materials and/or geometry adjustments.

| Name<img width=140/>                                                                                                                                          | Author<img width=200/>                                                         | License 
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----------------------  
| [3D Football](                   https://www.cgtrader.com/free-3d-models/sports/game/3d-foot-ball                                                             ) | [Prabath Weerapana](https://www.cgtrader.com/designers/prabath-weerapana)    | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license) 
| [Baseball Bat](                  https://www.cgtrader.com/free-3d-models/military/melee/baseball-bat-5c0d0b8c-0ff9-40f8-b49d-779978a2801b                     ) | [Sepand Jahrominejad](https://www.cgtrader.com/designers/sepandjahrominejad) | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license) 
| [FootBall American](             https://www.cgtrader.com/free-3d-models/sports/equipment/football-91c641b9-d246-4d71-a31c-d687762dd94f                       ) | [orsbone](https://www.cgtrader.com/designers/orsbone)                        | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license) 
| [Full French window](            https://www.cgtrader.com/free-3d-models/exterior/house/full-french-window                                                    ) | [getitgoodenglish](https://www.cgtrader.com/designers/getitgoodenglish)      | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license) 
| [Shutter Blind](                 https://www.cgtrader.com/free-3d-models/architectural/window/shutter-blind                                                   ) | [Harsh Srivastava](https://www.cgtrader.com/designers/harshstv)              | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license) 
| [Katana Samurai Sword](          https://www.cgtrader.com/free-3d-models/military/melee/katana-low-poly-59c307a4-5eaf-480d-b2a3-841d8d8c7240                  ) | [kizaru](https://www.cgtrader.com/designers/kizaru)                          | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license) 
| [Traffic Cone](                  https://www.cgtrader.com/free-3d-models/exterior/street-exterior/traffic-cone-5849a434-2331-4a90-9b87-087ccc16cd0c           ) | [hinndia](https://www.cgtrader.com/designers/hinndia)                        | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license)
| [Modern Outdoor Bench](          https://www.cgtrader.com/free-3d-models/exterior/street-exterior/park-bench-modern-outdoor-bench-long-seat                   ) | [VVei](https://www.cgtrader.com/designers/vvei)                              | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license)
| [Traffic Light](                 https://www.cgtrader.com/free-3d-models/exterior/street-exterior/traffic-light-3d-model-333af7df-30a4-47bf-9d12-77cf37249c86 ) | [Misam Rizvi](https://www.cgtrader.com/designers/dastan-persia)              | [Royalty Free Licence (no AI)](https://www.cgtrader.com/pages/terms-and-conditions#royalty-free-license)  
| [Luigi](                         https://www.turbosquid.com/3d-models/luigi-super-model-1308288                                                               ) | [Anthony Yanez](https://www.turbosquid.com/Search/Artists/Anthony-Yanez)     | [TurboSquid 3D Model License](https://blog.turbosquid.com/turbosquid-3d-model-license/#3d-model-license) 
| [Soccergoal](                    https://www.turbosquid.com/3d-models/soccergoal-3d-model-1840894                                                             ) | [NorbertVarga](https://www.turbosquid.com/Search/Artists/NorbertVarga)       | [TurboSquid 3D Model License](https://blog.turbosquid.com/turbosquid-3d-model-license/#3d-model-license) 
| [BBQ Grills](                    https://sketchfab.com/3d-models/bbq-grills-99f8e23e8d38459eb75a82d5092251af                                                  ) | [Caboose3d](https://sketchfab.com/caboose3d)                                 | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Clio Williams](                 https://sketchfab.com/3d-models/renault-clio-williams-1dad7e4438c74f3b8bac1ab72acd78ed                                       ) | [Mona x Supercars](https://sketchfab.com/Car2022)                            | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Generic Passenger Car Pack](    https://sketchfab.com/3d-models/generic-passenger-car-pack-20f9af9b8a404d5cb022ac6fe87f21f5#download                         ) | [Comrade1280](https://sketchfab.com/comrade1280)                             | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Modular Roof Shingles](         https://sketchfab.com/3d-models/modular-roof-shingles-e3ac8836d9ba4929bb8fe9399902dbf0                                       ) | [mephistophia](https://sketchfab.com/mephistophia)                           | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Road Barrier](                  https://sketchfab.com/3d-models/road-barrier-509578ba0a4143ef8af3826ab2217044                                                ) | [Faheem Yusuf](https://sketchfab.com/FameProductions)                        | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Road Block_B](                  https://sketchfab.com/3d-models/road-block-b-3fb46f4de80244849abdf992047dafad                                                ) | [Den](https://sketchfab.com/dfomenco)                                        | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Trash Can](                     https://sketchfab.com/3d-models/trash-can-f1fee32f875244679827c8a7962dd920                                                   ) | [Woh](https://sketchfab.com/WillBarrow)                                      | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Woord door collection](         https://sketchfab.com/3d-models/wood-door-collection-948ae091149548d3a5e604ecec63735b                                        ) | [PremModel](https://sketchfab.com/PremModel)                                 | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Window](                        https://sketchfab.com/3d-models/window-13ca5449e53043ceb4523dfb656ba827                                                      ) | [Geug](https://sketchfab.com/Geug)                                           | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Moto helmet with Vertigo logo]( https://sketchfab.com/3d-models/moto-helmet-with-vertigo-logo-cc2d7c15d4484363bbc1f9c2000799ec                               ) | [Aleksandr Sagidullin](https://sketchfab.com/jintrim3)                       | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Real Motorbike 02](             https://sketchfab.com/3d-models/real-motorbike-02-unity3d-f24e366933c54835b562e5210d93047f                                   ) | [jsa201077](https://sketchfab.com/unityjsa7)                                 | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
| [Fence Pack - Low Poly Style](   https://sketchfab.com/3d-models/fence-pack-low-poly-style-3097a414bb724390aa7ee3c9913dc04d                                   ) | [Tiko](https://sketchfab.com/tikoavp)                                        | [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)

### Textures

| Name<img width=140/>                                                     | Author<img width=200/> 	                                            | License 											
| ------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ----------------------
| [Asphalt005](  https://ambientcg.com/view?id=Asphalt005                ) | [ambientcg.com](https://ambientcg.com)                                 | [CC0 1.0](https://docs.ambientcg.com/license/)   
| [Concrete020]( https://ambientcg.com/view?id=Concrete020               ) | [ambientcg.com](https://ambientcg.com)                                 | [CC0 1.0](https://docs.ambientcg.com/license/)   
| [Garage Door]( https://www.sharetextures.com/textures/wood/garage-door ) | [Tolga Arslan](https://www.sharetextures.com/author/mtolgaarslan)      | [CC0 1.0](https://www.sharetextures.com/p/terms)   
| [Tiling 23](   https://www.sharetextures.com/textures/wood/garage-door ) | [Tolga Arslan](https://www.sharetextures.com/textures/floor/tiling_23) | [CC0 1.0](https://www.sharetextures.com/p/terms)

Blue noise textures were generated using [FastNoise](https://github.com/electronicarts/fastnoise) and [importance-sampled-FAST-noise](https://github.com/electronicarts/importance-sampled-FAST-noise)
           
### Sounds

# Misc

These tools are not mandatory but can be useful for development.

| Name<img width=140/>                                 | Info<img width=200/>              
| ---------------------------------------------------- | ------------------------- 
| [Radeon Developer Panel]( https://gpuopen.com/rdp/ ) | GPU debugging & profiling 
| [RenderDoc](              https://renderdoc.org/   ) | GPU debugging

vgframework

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

vgframework

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README