Add README and fix package manifest

Publisher name in the manifest needs to match the
actual name of the account that publishes the package.
This commit is contained in:
Ignacio Etcheverry
2020-06-13 13:52:28 +02:00
parent 9c0de9611b
commit 98f4d2bf93
2 changed files with 31 additions and 2 deletions

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
<Metadata>
<Identity Id="Godot.Addin" Version="1.0" Language="en-US" Publisher="Godot Engine" />
<Identity Id="Godot.Addin" Version="1.0" Language="en-US" Publisher="Ignacio Roldán Etcheverry" />
<DisplayName>Godot Addin</DisplayName>
<Description xml:space="preserve">Support for Godot Engine C# projects, including debugging and extended code completion.</Description>
<License>LICENSE.txt</License>
@@ -9,7 +9,7 @@
<Tags>Godot</Tags>
</Metadata>
<Installation>
<InstallationTarget Version="[16.0,)" Id="Microsoft.VisualStudio.Community" />
<InstallationTarget Version="[16.0,17.0)" Id="Microsoft.VisualStudio.Community" />
</Installation>
<Assets>
<Asset Type="Microsoft.VisualStudio.MefComponent" d:Source="Project" d:ProjectName="GodotCompletionProviders" Path="|GodotCompletionProviders|" />

29
README.md Normal file
View File

@@ -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.