From 98f4d2bf939a4ad6b7ee51ac373989d977e33b2f Mon Sep 17 00:00:00 2001 From: Ignacio Etcheverry Date: Sat, 13 Jun 2020 13:52:28 +0200 Subject: [PATCH] Add README and fix package manifest Publisher name in the manifest needs to match the actual name of the account that publishes the package. --- GodotAddinVS/source.extension.vsixmanifest | 4 +-- README.md | 29 ++++++++++++++++++++++ 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/GodotAddinVS/source.extension.vsixmanifest b/GodotAddinVS/source.extension.vsixmanifest index 306ab71..84da09d 100644 --- a/GodotAddinVS/source.extension.vsixmanifest +++ b/GodotAddinVS/source.extension.vsixmanifest @@ -1,7 +1,7 @@ - + Godot Addin Support for Godot Engine C# projects, including debugging and extended code completion. LICENSE.txt @@ -9,7 +9,7 @@ Godot - + diff --git a/README.md b/README.md new file mode 100644 index 0000000..57dcd87 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Godot C# extension for Visual Studio +Visual Studio extension for the Godot game engine C# projects. + +## Requirements + +**Godot 3.2.2** or greater. Older versions of Godot are not supported. + +## Features + +- Debugging. +- Launch a game directly in the Godot editor from Visual Studio. +- Additional code completion for Node paths, Input actions, Resource paths, Scene paths and Signal names. + +**NOTES:** + +- A running Godot instance must be editing the project in order for code completion and the `Play in Editor` debug target to work. +- Node path suggestions are provided from the currently edited scene in the Godot editor. + +## Debug targets + +- **Play in Editor**\ + Launches the game in the Godot editor for debugging in Visual Studio.\ + For this option to work, a running Godot instance must be editing the project. +- **Launch**\ + Launches the game with a Godot executable for debugging in Visual Studio.\ + Before using this option, the value of the _"executable"_ property must be changed + to a path that points to the Godot executable that will be launched. +- **Attach**\ + Attaches to a running Godot instance that was configured to listen for a debugger connection.