Skip to content

Latest commit

 

History

History
343 lines (268 loc) · 12.7 KB

README.md

File metadata and controls

343 lines (268 loc) · 12.7 KB

KMIDS-UE5-V1-2025

This repository contains the latest development of the KMIDS Unreal Engine 5 (UE5) project for 2025. Below, you'll find details on how to contribute, clone the project, and work around issues related to Microsoft Azure DevOps Git LFS.

Contribution Guidelines

For detailed instructions on how to contribute to this project, please refer to CONTRIBUTING.md.

Table of Contents

Tutorial for Downloading All C++ Requirements for Unreal Engine 5 (Windows/Mac/Linux)

This guide will walk you through the necessary steps to download and set up all the tools and libraries required to run Unreal Engine 5 (UE5) C++ projects on Windows, Mac, and Linux. It will cover the installation of the Unreal Engine, Visual Studio (Windows), Xcode (Mac), or other necessary build tools for each platform.

Windows Setup

1. Install Epic Games Launcher

  1. Visit the Epic Games website.
  2. Download and install the Epic Games Launcher.
  3. After installation, open the Epic Games Launcher and sign in with your Epic Games account.

2. Install Unreal Engine 5

  1. In the Epic Games Launcher, go to the Unreal Engine tab.
  2. Click Install Engine to download and install Unreal Engine 5 (UE5).

3. Install Visual Studio

Unreal Engine uses Visual Studio as the default IDE for Windows.

  1. Visit the Visual Studio download page.
  2. Download Visual Studio Community Edition (or any other edition you prefer).
  3. During installation, select the following components:
    • Desktop development with C++
    • Game development with C++
    • Windows 10 SDK
    • .NET desktop development
  4. After installation, launch Visual Studio to complete the setup.

Helpful Youtube tutorial: https://youtu.be/HQDskHVw1to

4. Set Up Git

  1. Download and install Git.
  2. Open Git Bash and run the following commands to configure Git: 
    git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

5. Install Git LFS (Large File Storage)

  1. Download and install Git LFS for Windows from Git LFS Windows Installer.
  2. After installation, open CMD and run the following command to initialize Git LFS 
    git lfs install

Mac Setup

1. Install Epic Games Launcher

  1. Visit the Epic Games website.
  2. Download and install the Epic Games Launcher for macOS.
  3. After installation, open the Epic Games Launcher and sign in with your Epic Games account.

2. Install Unreal Engine 5

  1. In the Epic Games Launcher, go to the Unreal Engine tab.
  2. Click Install Engine to download and install Unreal Engine 5 (UE5).

3. Install Xcode

Unreal Engine requires Xcode for compiling C++ code on macOS.

  1. Open the Mac App Store and search for Xcode.
  2. Install Xcode (ensure you have the latest version).
  3. After installation, open Xcode and agree to the terms and conditions.
  4. Install additional components by running the following command in the terminal: 
    xcode-select --install

4. Set Up Git

  1. Download and install Git for macOS.
  2. Open the terminal and run the following commands to configure Git: 
    git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

5. Install Git LFS (Large File Storage)

  1. Install Git LFS using Homebrew. If you don’t have Homebrew installed, follow the installation instructions on Homebrew's website.

    To install Homebrew, run the following command in the terminal:

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  2. Once Homebrew is installed, run the following command to install Git LFS:

    brew install git-lfs

  3. After installation, initialize Git LFS by running:

    git lfs install

Linux Setup (Ubuntu Example)

1. Install Unreal Engine 5

  1. Visit the Unreal Engine Linux page.
  2. Download the Unreal Engine 5 zip file for Linux.
  3. After the download is complete, extract the zip file to your desired directory.
    • You can use the following command in the terminal: 
      unzip Linux_Unreal_Engine_X.X.X.zip -d /path/to/destination
  4. Navigate to the extracted folder.
  5. Run the Unreal Engine 5 executable: 
    ./Engine/Binaries/Linux/UnrealEditor

2. Install Build Tools

  1. Open a terminal and run the following command to install necessary build tools:

    sudo apt install build-essential
sudo apt install clang
sudo apt install git
sudo apt install cmake

  2. Additionally, install dependencies required by Unreal Engine:

    sudo apt install libvulkan1
sudo apt install libxi6
sudo apt install libxrandr2
sudo apt install libx11-dev
sudo apt install libfreetype6-dev

3. Set Up Git

  1. Download and install Git for Linux. On most distributions, you can install Git using your package manager.

    For Ubuntu/Debian-based systems:

    sudo apt-get install git

  2. After installation, configure Git with the following commands:

    git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

4. Install Git LFS (Large File Storage)

  1. Open a terminal and install Git LFS using the package manager:

    sudo apt-get install git-lfs

  2. After installation, initialize Git LFS by running:

    git lfs install

Final Setup

After following the platform-specific steps, open Unreal Engine 5 and ensure your C++ environment is correctly set up by creating a new C++ project. This will confirm that all required tools are properly installed.

Additional Notes

  • For all platforms, make sure to keep your operating system and development tools up to date.
  • UE5 Documentation: Check the official Unreal Engine Documentation for more specific setup or troubleshooting steps.

Once everything is set up, you are ready to start developing with Unreal Engine 5 C++!

Cloning the Repository

For Contributors

If you are contributing to this project:

  1. Sign in to Azure DevOps using GitHub:

    • Visit Azure DevOps and log in with your GitHub account.
    • Notify me (Chayanon Ninyawee) once you are signed in.
    • I will add you to the project.

  2. Access the Repository:

  3. Generate Git Credential:

    • Click Clone and select the option to Generate Git Credentials (this will provide a Personal Access Token or PAT for authentication).
    • Save the generated username and password securely.

  4. Clone the Repository:

    • Use the following command to clone the repository: 
      git clone https://github.com/Chayanon-Ninyawee/KMIDS-UE5-V1-2025.git
    • Example Output: 
      Cloning into 'KMIDS-UE5-V1-2025'...
remote: Enumerating objects: 519, done.
remote: Counting objects: 100% (519/519), done.
remote: Compressing objects: 100% (489/489), done.
remote: Total 519 (delta 10), reused 519 (delta 10), pack-reused 0 (from 0)
Receiving objects: 100% (519/519), 64.91 KiB | 633.00 KiB/s, done.
Resolving deltas: 100% (10/10), done.
    • When prompted for credentials: 
      Username for 'https://dev.azure.com': <Put_Your_Username_Here>
Password for 'https://%20user@dev.azure.com': <Put_Your_Password_Here>

For Non-Contributors

If you only want to clone the repository:

  • Wait for the release.
  • The release will be available on this page, and it will not require signing in to Azure DevOps or dealing with Git LFS.

Setup Unreal Engine 5 Revision Control

  1. Click Revision Control on the bottom right.
  2. Select Git.

You may need to do this every time you open the project.

Setting Up Visual Studio Code for Unreal Engine 5

Follow these steps to set up Visual Studio Code (VS Code) for Unreal Engine 5 based on the guide from Epic Games:

1. Install Visual Studio Code

Download and install Visual Studio Code.

2. Install Required Extensions

Open VS Code and install the following extensions:

  • C++: Provides language support for C++.
  • CMake Tools: Useful for working with CMake projects.
  • CodeLLDB: Adds debugging capabilities.

To install extensions:

  1. Click on the Extensions view (Ctrl+Shift+X).
  2. Search for the extension names.
  3. Click Install.

3. Generate VS Code Project Files

  1. Open Unreal Editor and click Tools > Generate Visual Studio Code Project.

4. Configure the Project in VS Code

  1. Open the project in VS Code by clicking File > Open Folder and selecting your Unreal project folder.
  2. Wait for VS Code to index the project files.

5. Enable IntelliSense

Ensure your C++ configuration in VS Code is correct:

  1. Open the Command Palette (Ctrl+Shift+P).
  2. Search for and run C/C++: Edit Configurations (UI).
  3. Verify that the compilerPath points to your compiler (e.g., MSVC or Clang).
  4. Add the include paths for Unreal Engine. These can be found in the Engine/Source and your project’s Source folders.

6. Additional Tips

  • For better performance, exclude unnecessary folders from IntelliSense indexing. Add them to the .vscode/settings.json file:
{
    "files.exclude": {
        "**/Intermediate/**": true,
        "**/Saved/**": true,
        "**/Binaries/**": true
    },
    "C_Cpp.default.configurationProvider": "vector-of-bool.cmake-tools"
}
  • Regularly update your extensions for the latest features and fixes.

You are now ready to use VS Code with Unreal Engine 5!

Known Issues

Microsoft Azure DevOps Git LFS

There is currently a problem with Microsoft Azure DevOps Git LFS integration. This affects cloning the repository for users who are not explicitly added to the project.
To avoid this issue, contributors must:

  • Be added to the project by me.
  • Ensure they have access to Git LFS through Azure DevOps.

Stay tuned for updates and releases! If you encounter any issues or have questions, feel free to create an issue in the GitHub repository.