📈How to Setup

GIT

How to Clone the Repository

To get started with the 3DEngine project, you'll need to clone the repository to your local machine. Below, you'll find instructions using Git, a popular version control system. If you have another version control system you prefer, feel free to use that, ensuring you adapt the commands accordingly.

Using Git

  1. Open a terminal on your computer.

  2. Navigate to the directory where you want to clone the repository.

  3. Enter the following command:

    git clone https://github.com/CanTalat-Yakan/3DEngine.git

  4. Press Enter, and Git will begin cloning the repository to your specified directory.

After following these steps, you will have a local copy of the 3DEngine repository, and you're ready to explore or contribute to the project.

VISUAL STUDIO

Installing Visual Studio 2022 with Required Components

To set up your development environment for compiling the 3DEngine project, you must install Visual Studio 2022 along with specific components. Follow these steps:

  1. Visit the Visual Studio downloads page to download the Visual Studio 2022 installer.

  2. Run the installer and select the Desktop development with C++ workload during the installation process.

  3. Ensure to include the following individual components from the installation options:

    • Windows 11 SDK for the specific version required by the project. If the version is not listed, you may need to download it separately from the Microsoft website.

    • Windows App SDK to enable modern Windows UI development.

    • .NET 8.0 SDK for developing applications using the latest .NET capabilities.

  4. Continue with the installation process and wait for Visual Studio 2022 and the required components to be installed.

Once the installation is complete, you'll have all the necessary tools installed to compile and contribute to the 3DEngine project.

BUILD

Building the 3DEngine Project

After successfully installing Visual Studio 2022 and the required components, you can proceed with compiling the 3DEngine project. The project consists of three primary projects:

  • 3DEngine (Package)

  • Editor

  • Engine

To compile the 3DEngine (Package) for both the Editor and the Engine as standalone projects, follow these steps:

  1. Open the solution that contains the 3DEngine, Editor, and Engine projects in Visual Studio 2022.

  2. Set the 3DEngine (Package) project as the startup project by right-clicking on it in the Solution Explorer and selecting Set as Startup Project.

  3. To build the project, go to the Build menu and select Build Solution.

For the Editor, compiling the 3DEngine (Package) requires adding a new Certification:

  1. In the Solution Explorer, navigate to the 3DEngine (Package) project and double-click on the Package.appxmanifest file to open it.

  2. In the manifest editor window, switch to the last tab labeled Packaging.

  3. Click on the Choose Certificate button, then either create a new certificate by following the prompts or select an existing one from the store if available.

Completing these steps ensures that the 3DEngine (Package) is appropriately configured with a certification for development with the Editor.

PreviousUpcoming FeaturesNextUnderstanding this Project

Last updated