(WIP) General Porting Guide

[RodneyBaker]

Various code improvements and bug fixes exist but have not yet been ported into Opentoonz code. In some cases the code may be sufficient 'as is' while in others it can best be a starting point to build upon. Most porting potential would appear to be from the Tahoma2D fork of Opentoonz although that is just the most obvious. The general idea of porting is broad enough to encompass code from other areas as well although licensing and the preference of original authors should be considered in all cases.

Feature	Description	Constraint / Rationale	Reference	Status
Alignment Tools	Vector Alignment Tools	Port after T2D v1.5 (est. Dec 2024)	Request: opentoonz/opentoonz#5139 Implementation: #1275
IwaWarper Enhancements	Several UI/process improvements	Use standalone IwaWarper for main warping feature	https://github.com/opentoonz/iwawarper
Additional MyPaint brushes	Over 300 brushes exist - How can they best be accessed by users	A better system for UI control of brushes is needed

Bugfix	Description	Notes	Reference	Status

Additional

Title	Description	Considerations	Reference
Control Net for Rigging	AI assisted workflows	Early (Ideation) stage - AI integration inevitable	opentoonz/opentoonz#5445	Need Champions
Timeline duplicate created after original in Level Strip		Needs to be considered carefully as it does change current process	tahoma2d/tahoma2d#1491
Fix context menu in rename fields		Style Sets are currently not available in Opentoonz	#1494

[RodneyBaker]

This is very much a work in progress document.
Please feel free to add notes and we'll hide them as appropriate as they are incorported into the list.

Ideally, porting of bug fixes is the priority.

For information about porting code from Tahoma2D please reference: tahoma2d/tahoma2d#1118

For convenience, the entire text of that reference at time of this posting is as follows:

Technically speaking, no one really has any say or control on what gets ported, except maybe whomever is merging the PRs. Regardless, here are some guidelines to be respectful of the original developers and their work.

Always give credit to the original developer by either of the following methods:

Add appropriate Co-Authored By information to the initial commit message.
Co-Authored-By: manongjohn <19245851+manongjohn@users.noreply.github.com>
Co-Authored-By: jeremybullock <79284068+jeremybullock@users.noreply.github.com>
For those who are git-savvy, create a patch from the original PR and use git am.
If you are paying someone to port something over:

Offer to pay the original developer FIRST, especially if the developer is active.
If the developer is not active or they decline, then go ahead and pay someone else.
Please be fair with your offer, keeping mind the developer's original effort as well as porting may not be straight forward.
New features/Enhancements initially developed in one, should wait to be ported to the other until after it has been officially released it in their next version.

T2D tends to release AFTER OT, so this is more of a concern when porting from T2D to OT.
Existing bug fixes, especially for crashes, do not have to follow this.```

[RodneyBaker]

Additional information about the process itself should follow as we want to assist developers in that effort and educate the Opentoonz community on the process.

Regarding 'who did what and when' please refer to the history found in github records.

[RodneyBaker]

Here we'll collect information on ports that have been completed and add any notes relevant to post mortems.

Completed ports

Feature	Description	Constraint	Reference	Status	Post Mortem Refs
Undo Endblocks	Effort to track down Undo bugs	N/A	tahoma2d/tahoma2d#260	Completed (code matches - slight commentary differences)

[RodneyBaker]

Identified as a fix needing to be ported:

tahoma2d/tahoma2d#1062

[RodneyBaker]

opentoonz/opentoonz#3884 This request mirrors the feature of Tahoma 2D called 'Refer Visible'

There are known issues with the Refer Visible feature such as color spills (almost always horizontally) so the timeframe for any porting is unlikely for the near term.