From 10d361a5cf459f15fade02a7b505683ea69fa475 Mon Sep 17 00:00:00 2001 From: Marco Antonio Jaguaribe Costa Date: Mon, 8 May 2023 06:28:37 -0300 Subject: [PATCH 1/2] Add instructions to the README.md file --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index a57b7004d..e428975ae 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,20 @@ Visit the [releases page](https://github.com/1dot13/source/releases) to download (those issues can occur due to the combination of old game and modern OS/hardware, cnc-ddraw helps to avoid those) +### First Time Building on Windows + +1. Run `Visual Studio 2019` or newer. +2. Click `Clone a repository`, enter `https://github.com/1dot13/source.git` on `Location` and click `Clone`. +3. Double-click on `Folder View` on the `Solution Explorer` +4. You will get a CMake error saying `No existing preset was found, copied a preset template to [some_path]`. This is normal and only happens once. +5. Click on the dropdown that says `x64-Debug` and select `Manage configurations...`. This should trigger Visual Studio to load the `CMakeUserPresets.json` file it just copied. +6. Click `Build -> Build All` to build an English Ja2 v.1.13 Debug executable. + +To configure other languages and executables such as Unfinished Business and Map Editor, click the configuration dropdown (where it says `1dot13 Debug`, `1dot13 RelWithDebInfo` or `1dot13 Release`), choose `Manage Configurations...` and edit the `"Languages"` and `"Applications"` field to suit your needs. + +For debugging within the IDE, put the path to the Ja2 1.13 installation (with appropriate `gamedir` installation!) on the `CMAKE_RUNTIME_OUTPUT_DIRECTORY` field. + + ### Reports For more information and reports, visit [Bug reports at Bear's Pit Forum](http://thepit.ja-galaxy-forum.com/index.php?t=thread&frm_id=216&) or join the [Bear's Pit Discord](https://discord.gg/GqrVZUM "Bear's Pit Discord") From d69a4057c863733b363a4b0cf82be9b531b9c8ba Mon Sep 17 00:00:00 2001 From: majcosta <34732933+majcosta@users.noreply.github.com> Date: Tue, 9 May 2023 12:07:48 -0300 Subject: [PATCH 2/2] Update README.md Co-authored-by: Robert Biter --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e428975ae..e5c4d5164 100644 --- a/README.md +++ b/README.md @@ -56,18 +56,19 @@ Visit the [releases page](https://github.com/1dot13/source/releases) to download (those issues can occur due to the combination of old game and modern OS/hardware, cnc-ddraw helps to avoid those) -### First Time Building on Windows +### Visual Studio setup 1. Run `Visual Studio 2019` or newer. -2. Click `Clone a repository`, enter `https://github.com/1dot13/source.git` on `Location` and click `Clone`. -3. Double-click on `Folder View` on the `Solution Explorer` -4. You will get a CMake error saying `No existing preset was found, copied a preset template to [some_path]`. This is normal and only happens once. -5. Click on the dropdown that says `x64-Debug` and select `Manage configurations...`. This should trigger Visual Studio to load the `CMakeUserPresets.json` file it just copied. -6. Click `Build -> Build All` to build an English Ja2 v.1.13 Debug executable. - -To configure other languages and executables such as Unfinished Business and Map Editor, click the configuration dropdown (where it says `1dot13 Debug`, `1dot13 RelWithDebInfo` or `1dot13 Release`), choose `Manage Configurations...` and edit the `"Languages"` and `"Applications"` field to suit your needs. - -For debugging within the IDE, put the path to the Ja2 1.13 installation (with appropriate `gamedir` installation!) on the `CMAKE_RUNTIME_OUTPUT_DIRECTORY` field. +2. Clone and open the location with the source code using one of these two options: + * Click `Clone a repository` + * Enter `git@github.com:1dot13/source.git` or `https://github.com/1dot13/source.git` in the Repository location field, select the path you want to clone the repository to and click `Clone`. + * Double-click on `Folder View` in the `Solution Explorer` + * Click `Open a local folder` + * Use this option if you already cloned the repository yourself. +3. Visual Studio will automatically detect the CMake configuration files and will run the CMake generation. There will bet a CMake error in the logs saying `No existing preset was found, copied a preset template to [some_path]`. This is normal and only happens once. +4. Click on the dropdown that says `x64-Debug` and select `Manage configurations...`. This should trigger Visual Studio to load the `CMakeUserPresets.json` file it just copied. Now you can close the window for managing the configurations. +5. The `x64-Debug` option should have been replaced by `1dot13 Debug`. Click it and select `Manage configurations...` again. Here is where you configure the language for the built executables as well as which ones to build, Most important, here is where you set `CMAKE_RUNTIME_OUTPUT_DIRECTORY` to the path to your JA2 1.13 installation. This will be used for debugging. Note that the path needs to have a working 1.13 installation, and that includes the 1.13 game data. +6. You can use `Build -> Build All` to build the executables you selected in the configuration. ### Reports