search

o3de / o3de.org

The O3DE website
Other
86 stars 161 forks source link

[DOCS] How to Set up a Visual Studio Code Workspace #1521

Open AMZN-Gene opened 2 years ago

AMZN-Gene commented 2 years ago

Describe the issue briefly

Some developers use "Visual Studio Code" instead of "Visual Studio". This is especially the case when working on Linux where Visual Studio isn't available. I'd like tips on how to setup an O3DE engine and game project Code workspace.

Does this work have an engineering dependency?

No

AMZN-Gene commented 2 years ago

vscode_workspace.zip Here's a start for getting a vs code workspace working for an external project. you would unzip this into your external project's folder so that the root has project.code-workpace and the .vscode folder. This setup assumes your building as the project manager app would build where the build goes into the /build/linux.

Note that .vscode/c_cpp_properties.json references compile_commands.json. Compile_commands.json doesn't get generated if using Unix Make to generate, instead you'll need to use Ninja. Ex: cmake -B build/linux -S . -G "Ninja Multi-Config" -DLY_PROJECTS=MyProject This is important to note because, unfortunately, building via Project Manager doesn't generate compile_commands.json :C

Remember to modify .vscode tasks.json so that the args for building game and server launcher match your project name. Also remember to edit project.code-workspace 2 folder path to match where the o3de engine is stored on your machine.

sptramer commented 2 years ago

Proposed by @Ulrick28 that this be a blog, which is a good idea over site docs.

chanmosq commented 1 year ago

@o3de/lf -- A suggestion for a blog