Giter Club home page Giter Club logo

Comments (4)

rodolforg avatar rodolforg commented on June 24, 2024

I suggest to add at least two more metadata to plugin description:

  • minimum Synfig version (maybe maximum too if known)
  • minimum Python version (maybe ma too if known)

from synfig.

veermetri05 avatar veermetri05 commented on June 24, 2024

@rodolforg , thanks for the suggestion.

I am running a little later than my schedule. I will cover it up within this week.
Firstly let's begin by defining proper specifications and requirements for Plugin.

Defining a Plugin (from docs)
The Plugins feature allows users to run custom Python scripts directly from the Synfig Studio menu. Each script takes the .sif file as the first argument and will modify its contents in some way. After script execution finished, the file is automatically reopened back in Synfig Studio.

Structure of plugin

Plugin directory structure:

  • plugin.xml
  • default_config.xml
  • main.py

A new file format: .sipz (Synfig Plugin Zipped)
This is a zipped file containing the above files (will include more specific details, once I have a clear understanding of underlying working) (Ref: zstreambuf.cpp)

Here's an overview of how the installation will work.
Accept the sipz file.
Extract the content.
Check for the required files
Check if the required files are valid.
If everything is valid, then move the content to the plugins directory.

Community: Give me guidance and suggestions regarding this.
I will take a look at the code and start experimenting.

Questions that I need feedback from the community.

Where to access Plugin Manager Dialog?
Some possible options are:

  1. From preferences (a new tab named "Plugins")
  2. From the Plug-Ins Menu

I think we should go with the Plug-Ins menu.

from synfig.

ice0 avatar ice0 commented on June 24, 2024

A new file format: .sipz (Synfig Plugin Zipped)

Is this necessary, or can we skip this step for now?
Currently we do not pack plugin files, because it's easier to store them in git (compare/edit/etc).
The Debian package also requires non-binary files for packaging.
Therefore, it is better to pack them only for the release build (if required).

from synfig.

rodolforg avatar rodolforg commented on June 24, 2024

Is this necessary, or can we skip this step for now?
Currently we do not pack plugin files, because it's easier to store them in git (compare/edit/etc).

The intent here is to ease other developers to release their plugins without it being in synfig source code, for example.
Veermetri wrote some of them as well as Mattias Bassaglia. And their distribution as basically a git repository...

from synfig.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.