Skip to content

Commit

Permalink
Updated plugin-dev-readme (#606)
Browse files Browse the repository at this point in the history
  • Loading branch information
igor84 authored Nov 19, 2023
1 parent a9e8c39 commit 441f6df
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ Restore nuget packages of a single Unity Project: `dotnet nugetforunity restore

NugetForUnity has plugin support. If you open the NugetForUnity section in Unity preferences it will list the plugins you have installed in your project and you can enable them from there.

Plugins are any dlls which contain NugetForUnityPlugin in their name and have a class inside them that implements the `INugetPlugin` interface. They can be placed anywhere inside the project (inside the `Assets` directory) and can even be installed as a nuget package.
Plugins are any dlls which contain NugetForUnityPlugin in their name and have a class inside them that implements the `INugetPlugin` interface. They can be placed anywhere inside the project (inside the `Assets` directory).

If you are interested in implementing a plugin read the [plugin development documentation](plugin-dev-readme.md).

Expand Down
2 changes: 1 addition & 1 deletion plugin-dev-readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to develop a NuGetForUnity Plugin you need to start with these steps:
2. You plugin project name should be <PluginName>.NugetForUnityPlugin since the plugin loader will look for dlls which contain NugetForUnityPlugin in its name.
3. If you are targeting Unity older than 2021.3 create a `.netstandard2.0` C# library project.
4. If you are targeting Unity 2021.3 or newer create a `.netstandard2.1` C# library project.
5. NuGetForUnity contains NuGetForUnity.PluginAPI.dll that you need to add as a reference in your project. You can install the `NuGetForUnity.PluginAPI` nuget package, copy it to your project or reference it using a relative path from some other place.
5. Add a reference to [NuGetForUnity.PluginAPI](https://www.nuget.org/packages/NuGetForUnity.PluginAPI) nuget package in your project. This package contains the interfaces that you will need to implement.
6. Depending on the needs of your plugin you might also need to add references to `UnityEngine.dll` and `UnityEditor.dll` from your Unity installation.
7. Write a class that implements `INugetPlugin` interface. In the `Register` method you will get a `INugetPluginRegistry` that has methods you can use to register your classes that implement custom handling of certain functionalities like installing and uninstalling the packages.

Expand Down

0 comments on commit 441f6df

Please sign in to comment.