Skip to content

Commit

Permalink
add dependency information
Browse files Browse the repository at this point in the history
  • Loading branch information
HendrikMennen committed Oct 20, 2024
1 parent 19396d4 commit bbae992
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/studio/04-plugins/03-write-plugin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,40 @@ public class TestExtensionModule : IModule
}
```

## The oneware-extension.json file

## Dependency management

Your created plugin will contain a oneware-extension.json. There you can specify the compatible and required dependencies.
For an empty plugin with basic dependencies it will look similar to this:

```json
{
"Dependencies": [
{
"Name": "OneWare.Essentials",
"MinVersion": "0.9.0.0",
"MaxVersion": "0.9.0.0"
}
]
}
```

Inside the .csproj file of your plugin you can see the added nuget packages:

Here you can see that OneWare Dependencies that are included in the IDE anyways are market with `Private="false" ExcludeAssets="runtime;Native"`, so ensure that these dependencies are not copied to the plugin archive. They still need to be added to make compilation work.

```xml
...
<ItemGroup>
<PackageReference Include="OneWare.Essentials" Version="0.9.0" Private="false" ExcludeAssets="runtime;Native" />
<PackageReference Include="OneWare.Settings" Version="0.30.3" Private="false" ExcludeAssets="runtime;Native" />
<PackageReference Include="OxyPlot.Avalonia" Version="2.1.0-Avalonia11" />
<PackageReference Include="SkiaImageView.Avalonia11" Version="1.5.0" />
</ItemGroup>
...
```

## API Documentation

The API is not ready yet, same goes for the documention.
Expand Down

0 comments on commit bbae992

Please sign in to comment.