Skip to content

IDE Setup Guide

Jump to bottom
CatIsNotFound edited this page Feb 20, 2026 · 5 revisions

IDE Setup Guide

For different operating systems, you can use this document to better help you install and configure the MyEngine project.

How to Choose an IDE?

Under different operating systems, you can choose any C++ Integrated Development Environment (IDE) for project development. Here are some commonly used C++ IDE options:

If you want to set up a C/C++ environment in one go, it is recommended to choose:

CLion is a powerful cross-platform IDE that supports all platforms (Windows, Linux, MacOS), has a relatively small footprint, and the project relies on CMake for building, with the corresponding compiler being MinGW. It is the most suitable IDE for installing or configuring the MyEngine project on this platform.

Visual Studio is beginner-friendly and fully compatible with the Windows platform. However, it has a relatively large footprint, and its corresponding compiler is MSVC.

IDE Configuration

Different IDEs have different configuration methods. Here are the configurations for the following mainstream IDEs:

JetBrains CLion

Configure Environment Variables (Windows)

ℹ️ Note:

On Windows systems, you do not need to install additional build tools such as MinGW, Ninja, or CMake, as CLion has built-in corresponding build tools.

All you need to do is configure the system environment variables so that you can directly use the corresponding build tools in any terminal.

You can right-click the Windows icon, select the System menu item, and open Advanced system settings in the settings. In the pop-up System Properties window, click the Environment Variables button. Next, you need to add the path to CLion's corresponding build tools to the system environment variables. Usually, you only need to add it to the Path environment variable.

Alternatively, you can directly run a script in PowerShell to add the path to CLion's corresponding build tools to the system environment variables. The specific steps are as follows:

Create a new file (e.g., set-clion-path.ps1), and execute the following command in PowerShell to add the path to CLion's corresponding build tools to the system environment variables. Before executing the following command, remember to replace $clionPath with your own CLion installation path.

# Need to modify $clionPath to your own path.
$clionPath = "\path\to\Jetbrains\Clion"
# Add the path to the system environment variable.
$newPath = "$clionPath\bin;$clionPath\bin\mingw\bin;$clionPath\bin\gdb\win\x64\bin;$clionPath\bin\ninja\win\x64;$clionPath\bin\cmake\win\x64\bin"
# Add the path to the user environment variable.
$currentUserPath = [Environment]::GetEnvironmentVariable("PATH", "User")
# Set the user environment variable.
[Environment]::SetEnvironmentVariable("PATH", "$currentUserPath;$newPath", "User")
# Current session will be affected.
$env:PATH = [Environment]::GetEnvironmentVariable("PATH", "User")

💡 TIPS:

Note that the above configuration only takes effect for the current user.

If you need it to take effect for all users, run PowerShell as an administrator and replace "User" with "Machine".

Install Build and Compilation Tools (Linux)

For specific installation methods, please refer to [Compiler Installation GNU GCC and Usage Guide](Compiler Installation Guide).

Install Build and Compilation Tools (MacOS)

For specific installation methods, please refer to [Compiler Installation GNU GCC and Usage Guide](Compiler Installation Guide).

How to Import the MyEngine Project?

Open the terminal directly and follow the [Quick Start → Source Repository Installation](Quick Start/#source-repository-installation) section in the document to configure, compile, and install the project.

Visual Studio

Installation

If you have never installed Visual Studio, open the Visual Studio Installer directly.

  • In the Available tab, select any IDE and click the Install button.

  • In the Workloads tab, select the Desktop development with C++ and C++ development tools for Linux and Mac workloads.

  • In the Installation location tab, modify the Product installation path, then click the Install button and wait for the download and installation to complete.

If you have already installed Visual Studio, click Tools -> Get Tools and Features in the menu bar to launch the Visual Studio Installer.

  • Select your IDE and click the Modify button.

  • In the pop-up window, select the Individual components tab.

  • Enter cmake in the search box and check the CMake component.

  • Click the Install button to install the CMake component.

How to Import the MyEngine Project?

Open the command line Developer PowerShell for VS or Developer Command Prompt for VS (located in the Visual Studio folder in the Start menu), and follow the [Quick Start → Source Repository Installation](Quick Start/#source-repository-installation) section in the document to configure, compile, and install the project.

Visual Studio Code

For configuration, please refer to the following links:

How to Import the MyEngine Project?

Open the terminal directly and follow the [Quick Start → Source Repository Installation](Quick Start/#source-repository-installation) section in the document to configure, compile, and install the project.

English
简体中文

Clone this wiki locally