Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Command Line Interface Issues and Considerations #1117

5 tasks
Jose-Moreno opened this issue Oct 26, 2018 · 0 comments
5 tasks

Command Line Interface Issues and Considerations #1117

Jose-Moreno opened this issue Oct 26, 2018 · 0 comments
Discussion Enhancement Tracker UX Related to the way users interact with the program


Copy link

Issue Summary

So hey thanks to scribblemaniac I learned that Pencil2D has a command line interface! nice 馃檪 I went to test it for some time and I noticed a few issues

  • Issue 1: The command line help should be a little bit more descriptive. I had to fiddle a lot to even understand that I had to actually write many options before exporting. Scribblemaniac also mentioned there were some elements missing as well which were already working but not documented.
  • Issue 2: There is a slight readability problem on windows since the CLI help appears on a dialog, so the formatting is out of place.

I wouldn't mind if it appeared on the console to be honest, but at least it should be more readable

  • Issue 3: When rendering a file we should see an export bar (or a percentage increment from 0 to 100%) , either on the console or as a dialog if possible, otherwise it's a bit unruly to know when Pencil2D has finished rendering.

  • Issue 4: After a lot of testing I've definitely noticed that exporting from Pencil2D editor ironically now uses LESS memory than when you use the command line rendering, which should not happen as the editor is only opened to track the file (from what I saw). Perhaps the active frame pool form the preferences is not being taken into account? does command line rendering not use the active pool or perhaps we have to set it as an "option" as well on the command?

  • Issue 5: This might require more testing on my behalf but as far as I noticed some options / settings in the editor are not "imported" from the file when using the CLI. The best thing when having multiple files to render, would be to save the settings on the file using the editor and just type the command:

pencil2d.exe -- export "C:\PATH\fileName.fileType" "C:\PATH\pencil2D_renderFile.pclx

That way the the CLI would use all the editor saved settings. Instead in my trial run I had to type the following:

pencil2d.exe --export "C:\PATH\cmd_export_test_.mp4" --camera "Camera Layer" --width 800 --height 600 --start 1 --end 1112 "C:\PATH\"

*PATH is meant to represent a full file path.

These were apparently the minimum amount of options I had to input before a successful render, but notice that I had to define: Which camera layer was being rendered (I had only one, might be more useful having more camera layers, but should default to render the first-index camera), I had to define the export size (which is the camera size), the start and end frame (which should be defined by the last keyframe container).
These are values that are present before exporting, you could also configure in the export dialog and Pencil2d could save them so the CLI can read those instead of re typing them. Of course explicitly defining them should overwrite them like any normal CLI would :o)


@Jose-Moreno Jose-Moreno added Enhancement Discussion UX Related to the way users interact with the program labels Oct 26, 2018
@Jose-Moreno Jose-Moreno added this to Low priority in Enhancement Priority Aug 31, 2020
@J5lx J5lx added the Tracker label Dec 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Discussion Enhancement Tracker UX Related to the way users interact with the program
Status: Low priority
Enhancement Priority
Low priority

No branches or pull requests

2 participants