Skip to content

Commit

Permalink
.vsconfig (#544)
Browse files Browse the repository at this point in the history
* Added .vsconfig to quickly set up Visual Studio

* Updated README.compile

* Renamed README.compile to COMPILE.md as common practice
  • Loading branch information
DarkWanderer authored Jan 10, 2025
1 parent fd49ef6 commit 134f50e
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 8 deletions.
34 changes: 34 additions & 0 deletions .vsconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"version": "1.0",
"components": [
"Microsoft.VisualStudio.Component.CoreEditor",
"Microsoft.VisualStudio.Workload.CoreEditor",
"Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions",
"Microsoft.VisualStudio.Component.Roslyn.Compiler",
"Microsoft.Component.MSBuild",
"Microsoft.VisualStudio.Component.TextTemplating",
"Microsoft.VisualStudio.Component.NuGet",
"Microsoft.VisualStudio.Component.Debugger.JustInTime",
"Microsoft.VisualStudio.Component.IntelliCode",
"Microsoft.VisualStudio.Component.VC.CoreIde",
"Microsoft.VisualStudio.Component.VC.Tools.x86.x64",
"Microsoft.VisualStudio.Component.Graphics.Tools",
"Microsoft.VisualStudio.Component.VC.DiagnosticTools",
"Microsoft.VisualStudio.Component.Windows11SDK.22621",
"Microsoft.VisualStudio.Component.VC.ATL",
"Microsoft.VisualStudio.Component.VC.ATLMFC",
"Microsoft.VisualStudio.Component.VC.Redist.14.Latest",
"Microsoft.VisualStudio.ComponentGroup.NativeDesktop.Core",
"Microsoft.VisualStudio.ComponentGroup.WebToolsExtensions.CMake",
"Microsoft.VisualStudio.Component.VC.CMake.Project",
"Microsoft.VisualStudio.Component.VC.TestAdapterForGoogleTest",
"Microsoft.VisualStudio.Component.VC.ASAN",
"Microsoft.VisualStudio.Component.Vcpkg",
"Microsoft.VisualStudio.Workload.NativeDesktop",
"Component.MDD.Linux",
"Component.Linux.CMake",
"Component.Linux.RemoteFileExplorer",
"Microsoft.VisualStudio.Workload.NativeCrossPlat",
"Microsoft.VisualStudio.Component.VC.Runtimes.x86.x64.Spectre"
]
}
23 changes: 16 additions & 7 deletions README.compile → COMPILE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ To build Orbiter from its sources you need a C++ compiler able to create Windows
Orbiter has been built successfully with Visual Studio 2019 Community
https://visualstudio.microsoft.com/downloads/

VS 2019 also has built-in support for CMake. If you use a different version or want to
configure the Orbiter build separately, you also need to install CMake.
https://cmake.org/download/
To quickly install Visual Studio components required for development, launch installer and
import the [.vsconfig](./.vsconfig) file provided in the repository ([documentation](https://learn.microsoft.com/en-us/visualstudio/install/import-export-installation-configurations?view=vs-2022#import-a-configuration-using-the-visual-studio-installer))

If you want to build the Orbiter documentation, you need LaTeX. Multiple LaTeX distros for
Windows are available, for example MiKTeX.
Expand Down Expand Up @@ -53,11 +52,21 @@ PLANETARY TEXTURES
The Orbiter git repository does not include the planetary texture files for most
celestial bodies. You need to install these separately (e.g. by installing Orbiter
2016 and optionally downloading high-res texture packs from the Orbiter website).
During CMake configuration, specify the location of the texture files in the
ORBITER_PLANET_TEXTURE_INSTALL_DIR entry. For example, if Orbiter 2016 is installed
in c:\orbiter2016, the texture directory would be c:\orbiter2016\Textures.

Alternatively, you can set the planetary texture directory after building
Set environment variable ORBITER_PLANET_TEXTURE_INSTALL_DIR in your profile so that
Orbiter build correctly configures the reference in configuration.

Assuming Orbiter 2016 is installed in c:\orbiter2016:

```
setx ORBITER_PLANET_TEXTURE_INSTALL_DIR c:\orbiter2016\Textures
```

Alternatively, you can specify the location of the texture files as CMake variable:
```
cmake --preset windows-x64-debug -DORBITER_PLANET_TEXTURE_INSTALL_DIR=c:\orbiter2016\Textures
```
You can also set the planetary texture directory after building
Orbiter by setting the PlanetTexDir entry in Orbiter.cfg.


Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ If you want to build the documentation, you need a few additional tools:
- [Doxygen](https://www.doxygen.nl/index.html) for building the source-level
documentation for developers.

See [README.compile](./README.compile) for details on building Orbiter.
See [COMPILE.md](./COMPILE.md) for details on building Orbiter.

## Planet textures

Expand Down

0 comments on commit 134f50e

Please sign in to comment.