<img src="doc/img/version.png" alt="VGF boy" title="VGF boy" align="right" height="74" />

VGFramework 0.55

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

Table of contents

Build status
Getting started
Licence
Extern libs
Assets
Misc

Build status

| Configuration |       Debug      | Development |     Release     |       Final       | |--------------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ARM64EC MSVC DX12 | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | | ARM64EC MSVC Vulkan | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | <div align="center"></div> | | Win64 MSVC DX12 | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | | Win64 MSVC Vulkan | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | | Win64 ClangCL DX12 | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | <div align="center"> </div> | | Win64 ClangCL Vulkan | <div align="center"></div> | <div align="center"></div> | <div align="center"></div> | <div align="center"> </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 and open it in your favorite development environment.
• Select solution Configuration and Platform
• Select the solution folder for 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 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 | --------- | ---- | ----------------