Unreal Engine 5.6 Sample Project
The official Unreal Engine 5.6 Sample Project demonstrates a complete, live integration of KK with standard Git hosting (GitHub) and native Google Drive. It serves as a ready-to-run template and reference project for game development teams.
- Engine Version: Unreal Engine 5.6 (C++ Third-Person Template)
- Git Location: https://github.com/godynheil/KKUETestProject.git
- Google Drive Storage: Public Folder Link
- Drive Folder ID:
1nz5DPRZnP1zlmnuKPeY4f9kNfKF71nSC
How it Works
Unreal Engine projects are notoriously difficult to track in pure Git due to large asset files (.uasset, .umap).
With KK, all large binary files are cleanly separated:
-
GitHub stores the lightweight source code (
.cpp,.h,.cs), project structure (.uproject), configuration (.ini), and tiny pointer files for all assets. - Google Drive serves as the object store, holding the content-addressed raw binary byte blocks securely.
Quick Clone Instructions
To clone and launch this project on your local machine, run the following steps:
Step 1: Clone the Repo Structure
kk clone git:https://github.com/godynheil/KKUETestProject.git
Step 2: Connect to the Public Google Drive Storage
cd KKUETestProject
kk setup gdrive --folder 1nz5DPRZnP1zlmnuKPeY4f9kNfKF71nSC
This opens your browser to securely authorize native Drive access using OAuth 2.0.
Step 3: Materialize Large Assets
kk pull-file .
KK automatically queries the public Drive folder and downloads the real binary assets (e.g., Content/large_asset.uasset), placing them right where the Engine expects them.
KKUETestProject.uproject to open and compile the project in Unreal Engine 5.6!
Workflow Verification
This exact project is utilized in KK's automated end-to-end integration tests (internal_tests/github/test-workflow-ue-project-github-gdrive.ps1) to guarantee complete reliability:
- Zero Large Files on Git: Tests bare-clone the GitHub repo and inspect all file sizes. Every single
.uassetfile is validated to be a tiny pointer (~111 bytes). - Object Store Consistency: Runs
kk fsckto verify object health and byte alignment. - Flawless Branching: Performs checkout, modifications, commits, and switches branches to guarantee pointer materialization works across branches.
kk track was required for this project! Because tracks are empty by default, KK automatically converted all non-code files (like .uasset files) to pointers during staging.