Skip to content

Update developer "getting started" docs #1985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Rainyan merged 3 commits into from
Jun 11, 2026
Merged

Update developer "getting started" docs #1985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93b7ed0
Add note about lack of support for vs2026 (for now)
Rainyan Jun 11, 2026
9583761
Add note about no official msvc 2026 support
Rainyan Jun 11, 2026
f90c6e4
Add new Run configuration info for Qt Creator
Rainyan Jun 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ See [README.md](README.md) in this repo for setting up your build environment (c
To be safe and avoid problems with VAC, it's recommended to add a [-insecure](https://developer.valvesoftware.com/wiki/Command_Line_Options) launch flag before attaching your debugger.

#### VS2022 + CMake (Windows)

> [!NOTE]
> We do *not* officially support Visual Studio 2026 at this time! If you run into issues, please consider downgrading to VS 2022 for now.
>

In the CMake Target View, right-click "client (shared library)" and click on "Add Debug Configuration". This should generate the `src/.vs/launch.vs.json` config file.

Modify the config to fix the directory paths; an example is provided below:
Expand Down Expand Up @@ -61,7 +66,13 @@ Modify the config to fix the directory paths; an example is provided below:
```

#### Qt Creator (Linux)
On the sidebar, click "Projects" then under your current kit, click "Run". Set the following:
On the sidebar, click "Projects" then under your current kit, click "Run".

By default, you may have one of the test configurations chosen as the currently active run configuration (`test_neo_crosshair`, etc).
To create a new configuration, press "Add" and choose "Custom executable" (tested on Qt Creator 13.0.0, but the exact menus and wording
may depend on your Qt Creator version).

Once you have a fresh *Run configuration* created, set the following properties for it:

| Property | Example value |
| :---------------------------------- | :------------ |
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ To see the Table of Contents, please use the "Outline" feature on GitHub by clic

* Windows: [Visual Studio 2022 (MSVC v143)](https://visualstudio.microsoft.com/downloads/)
* Make sure to include C++ development environment, C++ MFC Library, Windows 10/11 SDK, and CMake during installation
* Please note that we do not currently officially support Visual Studio 2026
* Linux: [Steam Runtime 3 "Sniper"](https://gitlab.steamos.cloud/steamrt/sniper/sdk)
* GCC/G++ 10 toolchain
* Compiled in the sniper's Docker/Podman/Toolbx container, schroot, or systemd-nspawn
Expand Down
Loading