Page 1 of 1

Submission Guidelines - please read before submitting

Posted: Sun Jan 14, 2018 2:28 pm
by SecondMan
Submissions to Reactor can be made either directly to GitLab, or here in the Submissions forum.

Atoms can be created manually, or with the help of the convenient Atomizer editor.

General

  • Before submitting anything for inclusion with Reactor, it is highly recommended to start a WIP topic for your tool in the appropriate forum. That way you can gather valuable feedback from testers that may help you polish your tool, and it helps the Reactor team to gauge the usefulness and functionality of eventual submission without having to go through rigorous testing of every single candidate - it's a community project, after all!
    The ultimate goal of Reactor is quality over quantity
    there may be exceptions... :-)
  • When posting a submission topic, it's always a good idea to include screenshots of your tool's UI and a detailed description when there isn't a prior tool development/feedback topic on WSL. If there is, even better, and don't forget to include a link to it.

Atoms and files

  • When categorising Reactor submissions, try to follow Fusion's internal tool categories rather than submision types.

    For example, don't use:

    Code: Select all

    Category = "Fuses/Creator",

    but do use:

    Code: Select all

    Category = "Tools/Creator",

Organise your submissions using subfolders

  • Please don't put your tools, comps, scripts, etc in the root Deploy folders like /Macros, /Comps or /Scripts. Imagine Reactor having thousands of them one day, and all of them ending up in the same folder. It would be a nightmare. So organise your work in an appropriate structure. If you're doing a set of tools this can be your username for example.
  • For tools like Macros and Fuses, try to follow Fusion's tool categories. So for example, if you have a tool named "EpicBlur" which fits the Tools/Blur category and is a Macro, Deploy it in /Macros/Blur/EpicBlur.setting.

Please avoid putting version numbers in your file names

  • Versions in file names can ultimately lead to clutter and confusion. Instead, put the version number in the Atom for your release. In the meantime, though, feel free to use the forum to keep track of development and older versions, as well as feedback from your users.

File extensions in Reactor are lower case

  • There are differences between operating systems and how they deal with case sensitivity, so we default to one. So please make sure to use .fuse, .setting, .comp, .fu etc...

Fuses

  • When preparing Fuses for inclusion with Reactor, please make sure they are consistently categorised and versioned. In FuRegisterClass, this can be done by setting REGS_Category and REG_Version. For the versioning, REG_Version takes an integer, and by convention version 1.0 equals REG_Version = 100,

    Here is an example of the Time3D Fuse:

    Code: Select all

    FuRegisterClass("Time3D", CT_Tool, {
    	REGS_Name = "Time3D",
    	REGS_Category = "Miscellaneous",
    	REGS_OpIconString = "T3D",
    	REGS_OpDescription = "Time 3D",
    	REG_OpNoMask = true,
    	REG_NoBlendCtrls = true,
    	REG_NoObjMatCtrls = true,
    	REG_NoMotionBlurCtrls = true,
    	REG_NoPreCalcProcess = true,
    	REG_Version = 100,
    	})