Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated plugin-dev-readme #606

Merged
merged 1 commit into from
Nov 19, 2023
Merged

Updated plugin-dev-readme #606

merged 1 commit into from
Nov 19, 2023

Conversation

igor84
Copy link
Collaborator

@igor84 igor84 commented Nov 14, 2023

I updated the plugin-dev-readme to include instructions to use NuGetForUnity.PluginAPI nuget package when developing plugins.

@@ -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).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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).
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, therefore they can also be installed as a NuGet package by themselves.

Not 100% sure by I think the information is helpful

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the part about plugin being installed as a nuget package because I realized it would cause issues as it is. For example if you are gitignoring the folder where you install packages because you are counting on NugetForUnity to download them for you then during CI build the packages would actually be installed wihout the plugin enabled because at the start up time there wouldn't yet be a plugin dll in the project.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could probably fix this by changing the order in witch the NuGet packages are restored and than force a Plugin reload. But for now we can merge the current changes.

@JoC0de JoC0de merged commit 441f6df into master Nov 19, 2023
8 checks passed
@JoC0de JoC0de deleted the plugin-readme-update branch November 19, 2023 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants