You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Updated build_with_msvc6 and build_with_clion_vc6_toolchain guides. Added a notice about debug builds. Streamlined parts of build_with_msvc6 and added Ninja as a requirement. (#59)
1. In the CMake profiles, enable the profiles you want to use. The available workflow presets are:
55
68
- `vc6` - Release build
@@ -58,7 +71,7 @@ compatibility with the original compiler from the game's development era. To com
58
71
59
72
For detailed information about each build configuration and their specific purposes, see the [Build Configurations Overview](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/build_configuration).
60
73
61
-
## Step 3: Configuring the Installation Path
74
+
## Step 4: Configuring the Installation Path
62
75
63
76
1. In the target application options, do the following:
64
77
@@ -69,13 +82,23 @@ compatibility with the original compiler from the game's development era. To com
69
82
- To avoid duplicate builds, remove the **Build** step.
70
83
- Save the configuration, and you are ready to build and run the project.
71
84
72
-
## Step 4: Compiling and Running the Project
85
+
## Step 5: Compiling and Running the Project
73
86
74
87
1. Now, click the **Build** button in CLion, or click **Install** in the build menu.
75
88
2. CLion will start the build/install process using the VC6 (x86) toolchain.
76
89
3. Once the build is successfully completed, an executable file will be generated and installed in the
77
90
game directory.
78
91
92
+
## Running Debug Builds
93
+
94
+
> **⚠️ Debug Build Requirements:** To run a debug build of the game, you need to have
95
+
> the following two files in the game directory alongside the built executable:
Copy file name to clipboardExpand all lines: SourceCode/Builds/build_with_msvc6.md
+74-22Lines changed: 74 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -17,37 +17,60 @@ Even if you do not know C++, you should still be able to compile the source code
17
17
understanding of how C++ is compiled is necessary. This includes knowing what the **compiler** and
18
18
**linker** do, as well as being able to interpret error messages and troubleshoot them effectively.
19
19
20
-
## Prerequisites
20
+
## Prerequisites and setting up the build environment
21
21
22
-
Download the following binaries and software and have them ready in a project folder.
22
+
Download and install the following tools and software needed for compilation.
23
23
24
-
-[Visual Studio 6.0 Portable](https://github.com/itsmattkc/MSVC600)
25
-
-[CMake 3.31.6](https://github.com/Kitware/CMake/releases/download/v3.31.6/cmake-3.31.6-windows-x86_64.msi) or [newer](https://cmake.org/download/#latest)
26
-
-[Git](https://git-scm.com/downloads)
27
-
28
-
> For simplicity, this guide will use the installers for Git and CMake and assumes the user will use the
24
+
> **ℹ️ Setup Note:** For simplicity, this guide will use the installers for Git and CMake and assumes the user will use the
29
25
default install folder for Visual Studio 6.0 Portable.
30
26
31
-
## Installing your build environment
27
+
### Visual Studio 6.0 Portable
28
+
29
+
**Download:**[Visual Studio 6.0 Portable](https://github.com/itsmattkc/MSVC600)
32
30
33
-
Installation of tools and software that are needed for compilation.
31
+
The original compiler used for game development.
34
32
35
-
### Install Visual Studio 6
33
+
**Installation:**
36
34
37
-
- Download the portable Visual Studio 6 as a ZIP file from GitHub.
38
-
- Extract the common and VC98 folders from the downloaded archive to the default install folder.
35
+
- Download the portable Visual Studio 6 as a ZIP file from GitHub
36
+
- Extract the `common` and `VC98` folders from the downloaded archive to the default install folder
- Enable the option to add CMake to the system path during the setup wizard.
56
+
> **Note:** Not required if using IDEs like CLion or Visual Studio 2022, as these include built-in CMake support.
47
57
48
-
### Install Git
58
+
**Installation:**
49
59
50
-
- Run the Git installer.
60
+
- Run the installer for CMake
61
+
- Enable the option to add CMake to the system path during the setup wizard
62
+
63
+
### Ninja *(added to system path)*
64
+
65
+
**Download:**[Ninja](https://ninja-build.org/)
66
+
67
+
> **Note:** Not required if using IDEs like CLion or Visual Studio 2022, as these include a bundled ninja binary.
68
+
69
+
**Installation:**
70
+
71
+
- Download the Ninja binary from the [Ninja releases page](https://ninja-build.org/)
72
+
- Extract the `ninja.exe` file to a folder of your choice
73
+
- Add the folder containing `ninja.exe` to your system's PATH environment variable
51
74
52
75
## Clone
53
76
@@ -117,18 +140,47 @@ set MSVCDir=C:\<VS6_INSTALL_PATH>\VC98
117
140
118
141
Run the following command based on the type of build you want to create:
119
142
120
-
-`cmake --workflow --preset vc6` for a release build.
121
-
-`cmake --workflow --preset vc6-debug` for a debug build.
122
-
-`cmake --workflow --preset vc6-profile` for a profile build.
143
+
- For a release build:
144
+
145
+
```shell
146
+
cmake --workflow --preset vc6
147
+
```
148
+
149
+
- For a debug build:
150
+
151
+
```shell
152
+
cmake --workflow --preset vc6-debug
153
+
```
154
+
155
+
- For a profile build:
156
+
157
+
```shell
158
+
cmake --workflow --preset vc6-profile
159
+
```
123
160
124
161
You will find a bunch of files in `build\vc6\<game name>` and a file called `generalszh.exe` or `generalsv.exe`.
125
162
126
163
For detailed information about each build configuration and their specific purposes, see the [Build Configurations Overview](https://github.com/TheSuperHackers/GeneralsGameCode/wiki/build_configuration).
127
164
128
165
### Install the game executable
129
166
130
-
Run ```cmake --install build\<vc6 build type>```, this will copy the executable to the retail game directory,
131
-
or you can copy it manually.
167
+
Run the following command to copy the executable to the retail game directory:
168
+
169
+
```shell
170
+
cmake --install build\<vc6 build type>
171
+
```
172
+
173
+
Alternatively, you can copy it manually.
174
+
175
+
### Running Debug Builds
176
+
177
+
> **⚠️ Debug Build Requirements:** To run a debug build of the game, you need to copy
178
+
> the following two files into the game directory alongside the built executable:
0 commit comments