Deploying a plugin

Fri 20. Jan 2017, 15:25

Hi,

It's quite weird, I've followed the documention to deploy my plugin (It's in AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\My.Plugin\1.0\AnyCPU), but it's not loaded by articy... By using the -api.DebugManifest option, it's working without problems and my plugin is loaded, but I can't manage to make it loaded without this option.

In the AnyCPU folder, I just need to copy all the generated files from VS, right? (PluginManifest.xml, My.Plugin.dll, etc...)

Here's how articy is launched (first lines from the log file):
2017-01-20 16:17:30 D-MainThre [I]: Launching Application 'articy:draft'
2017-01-20 16:17:30 D-MainThre [I]: Params: -loglevel 3 -api.pluginlog -singleuser
2017-01-20 16:17:30 D-MainThre [I]: CmdLine: "C:\Program Files\articy draft 3.0 (Dev)\bin\ArticyDraft.exe" -loglevel 3 -api.pluginlog -singleuser

Thanks!
slages
 
Posts: 6
Joined: Mon 16. Jan 2017, 16:22

Re: Deploying a plugin

Fri 20. Jan 2017, 15:57

Hi slages,

to diagnose those problems you can do the following:
Are you seeing the "global macro entry" icon in the main/ribbon toolbar after loading a project? (the {} icon with the "play" overlay) If yes, the last entry is an Plugin info screen which may display an error message why the plugin was not loaded or activated.
If you don't see it here you should take a look in the PluginApi.log file in %appdata%\nevigo\articy\3.x\Logs folder.

This should look something like this:

Code: Select all
[T]: Scanning plugin-folder 'C:\Users\peter\AppData\Roaming\Nevigo\Articy\3.x\Plugins\Local\'
[I]: Collecting versions of plugin 'Articy.ApplyColors' in folder 'C:\Users\peter\AppData\Roaming\Nevigo\Articy\3.x\Plugins\Local\Articy.ApplyColors'
[T]: Manifest 'C:\Users\peter\AppData\Roaming\Nevigo\Articy\3.x\Plugins\Local\Articy.ApplyColors\1.0\x64/PluginManifest.xml' not found.
[I]: Loading API plugin assembly: C:\Users\peter\AppData\Roaming\Nevigo\Articy\3.x\Plugins\Local\Articy.ApplyColors\1.0\AnyCPU\Articy.ApplyColors.dll
[T]: Loading plugin texts from 'C:\Users\peter\AppData\Roaming\Nevigo\Articy\3.x\Plugins\Local\Articy.ApplyColors\1.0\AnyCPU\PluginTexts.tpk'
[I]: Plugin 'Articy.ApplyColors' successfully loaded and initialized


The first "not found" is OK for Plugins that are are "AnyCPU" types.

I just have uploaded a sample plugin in two forms.
1. As installer version that installs to the profile folder (The signed "Release" version with name "Articy.ApplyColors")
2. The source code of that plugin with renamed name (-spaces) MdkSample.ApplyColors. This source is free for anyone to modify, and therefore uses that slightly other name.

The source code still needs some more comments and the texts need to be localized.

To use the source: just unzip, open the solution, add the nuget package and compile.

Hope that helps
User avatar
[Articy] Peter Sabath
Articy Staff
Articy Staff
 
Posts: 89
Joined: Wed 23. Nov 2011, 13:58
Location: Bochum

Re: Deploying a plugin

Fri 20. Jan 2017, 16:10

Thanks for pointing to the plugin api log, I've just installed the Apply Color plugin and it also fails to load, here's the content of the log file:
2017-01-20 17:06:40 D-MainThre [T]: Scanning plugin-folder 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\'
2017-01-20 17:06:40 D-MainThre [I]: Collecting versions of plugin 'Articy.ApplyColors' in folder 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\Articy.ApplyColors'
2017-01-20 17:06:40 D-MainThre [T]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\Articy.ApplyColors\1.0\x64/PluginManifest.xml' not found.
2017-01-20 17:06:40 D-MainThre [W]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\Articy.ApplyColors\1.0\AnyCPU/PluginManifest.xml' is invalid.
2017-01-20 17:06:40 D-MainThre [I]: No plugin assembly found for architecture 'x64' and version '1.0'
2017-01-20 17:06:40 D-MainThre [I]: Collecting versions of plugin 'My.Plugin' in folder 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\My.Plugin'
2017-01-20 17:06:40 D-MainThre [T]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\My.Plugin\1.0\x64/PluginManifest.xml' not found.
2017-01-20 17:06:40 D-MainThre [W]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\My.Plugin\1.0\AnyCPU/PluginManifest.xml' is invalid.
2017-01-20 17:06:40 D-MainThre [I]: No plugin assembly found for architecture 'x64' and version '1.0'
2017-01-20 17:06:43 D-MainThre [T]: Scanning plugin-folder 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\'
2017-01-20 17:06:43 D-MainThre [I]: Collecting versions of plugin 'Articy.ApplyColors' in folder 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\Articy.ApplyColors'
2017-01-20 17:06:43 D-MainThre [T]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\Articy.ApplyColors\1.0\x64/PluginManifest.xml' not found.
2017-01-20 17:06:43 D-MainThre [W]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\Articy.ApplyColors\1.0\AnyCPU/PluginManifest.xml' is invalid.
2017-01-20 17:06:43 D-MainThre [I]: No plugin assembly found for architecture 'x64' and version '1.0'
2017-01-20 17:06:43 D-MainThre [I]: Collecting versions of plugin 'My.Plugin' in folder 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\My.Plugin'
2017-01-20 17:06:43 D-MainThre [T]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\My.Plugin\1.0\x64/PluginManifest.xml' not found.
2017-01-20 17:06:43 D-MainThre [W]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\My.Plugin\1.0\AnyCPU/PluginManifest.xml' is invalid.


So it seems that the plugins are found but the manifests are invalid. But it works without problems if I directly specify the manifest... Any idea?
slages
 
Posts: 6
Joined: Mon 16. Jan 2017, 16:22

Re: Deploying a plugin

Fri 20. Jan 2017, 16:18

Which Version of articy:draft 3 are you using?

I have added / changed the signing requirements for a Nevigo binary distributed plugin recently.
You should use version 3.0.0.31011
User avatar
[Articy] Peter Sabath
Articy Staff
Articy Staff
 
Posts: 89
Joined: Wed 23. Nov 2011, 13:58
Location: Bochum

Re: Deploying a plugin

Fri 20. Jan 2017, 16:45

Hmm OK I've updated articy and your plugin is working. So I took the sources and built it myself and I got the error:
2017-01-20 17:42:14 D-MainThre [W]: Manifest 'C:\Users\Admin\AppData\Roaming\Nevigo\articy\3.x\Plugins\Local\MdkSample.ApplyColors\1.0\AnyCPU/PluginManifest.xml' is invalid.
Same than with my plugin.

Here's the manifest generated after the build:

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<PluginManifest Type="MacroPlugin">
<Name>MdkSample.ApplyColors</Name>
<Title>Re-apply color from Template</Title>
<Version>1.0</Version>
<MinimumArticyVersion>3.0</MinimumArticyVersion>
<Developer>Nevigo</Developer>
<Description>This plugin sets the current object color to the template default color.</Description>
<ProjectUrl>http://www.nevigo.com/ad3mdk</ProjectUrl>
<IconFile>Resources\Icon.png</IconFile>
<Tags>template colors</Tags>
<Properties>
<!-- Is this plugin multi-user safe and properly checks claiming -->
<Property Name="MultiUser" Value="true"/>
<!-- Can this plugin be used in single user projects -->
<Property Name="SingleUser" Value="true"/>
</Properties>
</PluginManifest>


It doesn't contain the Signature fields we can find in your prebuild plugin, is it normal?
slages
 
Posts: 6
Joined: Mon 16. Jan 2017, 16:22

Re: Deploying a plugin

Fri 20. Jan 2017, 17:13

Yes it is normal that the Signature Tags are missing.
They are only required to allow a plugin in the "Articy.*" namespace and to ensure that the manifest and plugin assembly are still the same we created here.

But you are right that this is not working properly. The reason is a wrong early out condition.

Until we upload a fixed version you can add

Code: Select all
<NameSignature>Foo</NameSignature>


to your PluginManifest.xml as a workaround. Any non empty text in the tag is sufficient.

Thanks for reporting this bug.
User avatar
[Articy] Peter Sabath
Articy Staff
Articy Staff
 
Posts: 89
Joined: Wed 23. Nov 2011, 13:58
Location: Bochum

Re: Deploying a plugin

Mon 23. Jan 2017, 09:07

Thanks a lot, it's working now!
slages
 
Posts: 6
Joined: Mon 16. Jan 2017, 16:22

Return to articy:draft Macro Devkit

Who is online

Users browsing this forum: No registered users and 10 guests

Who We Are
Contact Us
Social Links