Vultra

Vultra is a modern 3D engine for game development, graphics research and more.

(This project is under early development and WIP.)

Vultra is based on libvultra.

Features

• User-friendly Editor

Build Instructions

Prerequisites:

• Git
• XMake
• Vulkan SDK
• Visual Studio with MSVC if Windows
• GCC or Clang if Linux/Unix
• XCode with GCC or Apple Clang if macOS

Step-by-Step:

• Install XMake by following this.

• Clone the project:

  git clone --recursive https://github.com/zzxzzk115/Vultra.git

• Build the project:

  cd Vultra
  git submodule update --init --recursive
  xmake -vD

• Run the Editor

  xmake run VultraEditor

  Tips: For OpenXR programs, you may need to set the XR_RUNTIME_JSON environment variable. For debugging OpenXR programs without headsets, you may need Meta XR Simulator on Windows and macOS. On Linux, you can use Monado as the simulator.

TODO List

• Editor Windows
  • Asset Browser
    • Tree View
    • Filter
    • Grid View & List View
    • Right-click menus
      • Reimport
      • Create
      • Delete
      • Rename
  • Scene Graph
    • Tree View
    • Status View
    • Right-click menus
      • Create New Entity
      • Delete Entity
      • Rename Entity
      • Create Others
  • Scene View
    • Render Target View
    • Tool bar
      • Grab (Q)
      • Translate (W)
      • Rotate (E)
      • Scale (R)
      • More
    • 3D Gizmos
      • QWER gizmos
      • Orientation gizmos
      • Icon gizmos
        • Camera Icon
        • Camera View Frustum Debug Draw
    • Entity Selection
  • Game View
    • Render Target View
    • Tool bar
      • Resolution Picker
      • Zoom Factor Slider
      • More
  • Main Tool bar (Play, Next, Pause, Stop, etc.)
  • Inspector
    • Name
    • Flags
    • Transform
    • More
• Project Management
• Hot-Reload

License

This project is under the MIT license.