diff --git a/Makefile b/Makefile index f3e131344..3956d4d5f 100644 --- a/Makefile +++ b/Makefile @@ -27,6 +27,8 @@ Utilities --------- - update to update the repository to the most recent version. +- format_py to auto-format Python scripts. + endef # HELP_TEXT (end) @@ -125,6 +127,9 @@ report_po_progress: update: @git pull --rebase +format_py: + @autopep8 --in-place --recursive . + # ---------------------- # Help for build targets diff --git a/manual/addons/3d_view/precision_drawing_tools/download.rst b/manual/addons/3d_view/precision_drawing_tools/download.rst index 901f34ff6..9c4d15201 100644 --- a/manual/addons/3d_view/precision_drawing_tools/download.rst +++ b/manual/addons/3d_view/precision_drawing_tools/download.rst @@ -8,9 +8,10 @@ In this case you need only enable the Add-on in the Add-on Preferences. However, the latest releases can be found on our GitHub. -Downloads should only be taken the from the official releases page: +Downloads should only be taken the from the +`official releases page `__. + -https://github.com/Clockmender/Precision-Drawing-Tools/releases Patches and Commits, that may add new features and/or bug fixes may be downloaded from the Commits to the Master branch, no development code should be used @@ -55,6 +56,6 @@ again only edit the message section in quotes, not the PDT assignments. Issues ====== -Please report any issues, or feature request, etc. using the Issues section -of the PDT Repository (https://github.com/Clockmender/Precision-Drawing-Tools/issues), +Please report any issues, or feature request, etc. using the Issues section of the +`PDT Repository `__, that way they can be properly tracked, actioned and incorporated into the add-on. diff --git a/manual/addons/import_export/mesh_atomic.rst b/manual/addons/import_export/mesh_atomic.rst index 4bedd0e98..550ab7be7 100644 --- a/manual/addons/import_export/mesh_atomic.rst +++ b/manual/addons/import_export/mesh_atomic.rst @@ -42,14 +42,15 @@ See `Examples`_ at the end of this page. - A list of software that deals with PDB in different ways can be found on the `RCSB site `__. There also is `Vesta `__, `ASE `__ and all the - `quantum chemical calculators `__ used in research, which can create or even calculate atomic structures and store them in PDB/XYZ - files. + `quantum chemical calculators + `__ + used in research, which can create or even calculate atomic structures and store them in PDB/XYZ files. .. seealso:: **Forum** - - Please, use the `Blender Artists forum `__ for comments and questions or directly the `Blender chat `__. + - Please, use the `Blender Artists forum + `__ + for comments and questions or directly the `Blender chat `__. - There also is the possibility to ask questions on `Stack Exchange `__. However, note that some of the developers like Blendphys don't have enough credits, which are, however, needed to have the permission for giving answers on Stack Exchange. diff --git a/manual/addons/import_export/scene_3ds.rst b/manual/addons/import_export/scene_3ds.rst index bfb1cde63..755ae0e3c 100644 --- a/manual/addons/import_export/scene_3ds.rst +++ b/manual/addons/import_export/scene_3ds.rst @@ -7,7 +7,7 @@ Autodesk 3DS :Category: Import-Export :Menu: :menuselection:`File --> Import/Export --> 3D Studio (.3ds)` - :Version: 2.3.4 + :Version: 2.4.1 :Blender: 3.6 :Authors: Bob Holcomb, Campbell Barton, Sebastian Schrand :Maintainer: Sebastian Sille (NRGSille) @@ -36,7 +36,7 @@ Image Search This enables a recursive file search if an image file can't be found. Read Keyframe - Reads the keyframe tracks from a 3ds file and transforms the objects to the data wich was found. + Reads the keyframe tracks from a 3ds file and transforms the objects to the data which was found. Usually only one frame is found in static scenes, it will be imported to the timeline. If the 3ds scene is animated, the complete animation will be imported to the timeline. @@ -60,7 +60,7 @@ Apply Transform World Space Use world matrix instead of local matrix to transform the objects. - This is useful for older 3ds files from 3D Studio DOS wich only used world space to transform the objects. + This is useful for older 3ds files from 3D Studio DOS which only used world space to transform the objects. It is also useful if the object was exported without apply transform. @@ -73,6 +73,10 @@ Include Selection Only When checked, only selected objects are exported. Otherwise export all objects in the scene. +Write Keyframe + Writes the keyframe section of a 3ds file and exports the animation if an action was found. + The animation can be imported the same way, un-check if any importer crashes, + not every application can handle the keyframe section. Transform ^^^^^^^^^ @@ -88,11 +92,11 @@ Forward / Up Materials ========= -Materials in 3ds are defined in various color and percent chunks wich can include +Materials in 3ds are defined in various color and percent chunks which can include either integer percent and 24bit color values or float color and percent values, both can be read by the importer and will be converted to blender values. The exporter uses the integer values, since this is used from 3ds version 3 and above. -The material definitions wich Blender can use are the following: +The material definitions which Blender can use are the following: - 3ds Diffuse Color <-> blender Base Color - 3ds Specular Color <-> blender Specular Color @@ -101,8 +105,8 @@ The material definitions wich Blender can use are the following: - 3ds Mat Shin2 <-> blender Specular Intensity - 3ds Mat Shin3 <-> blender Metallic - 3ds Mat Opacity <-> blender Alpha inverted -- 3ds Mat Bump PCT <-> blender Normalmap Strength -- 3ds Self Illum PCT <-> blender Emission Strength +- 3ds Mat Bump PCT <-> blender Normal-map Strength +- 3ds Self Illumination PCT <-> blender Emission Strength Textures @@ -111,8 +115,8 @@ Textures Each 3ds material can include different texture mappings, which are all imported to Blender material nodes including texture coordinates. The 3ds exporter basically takes the images and coordinates, -wich are directly connected to the Principled BSDF shader, -if an image is connected to a colormix shader, it will exported as secondary texture. +which are directly connected to the Principled BSDF shader, +if an image is connected to a color-mix shader, it will exported as secondary texture. Shininess maps to roughness and opacity to the alpha channel, they must be color inverted afterwards to match with Blender definition. The material mappings are defined as following: @@ -122,9 +126,9 @@ The material mappings are defined as following: - 3ds Shininess Map <-> blender Roughness Texture - 3ds Reflection Map <-> blender Metallic Texture - 3ds Opacity Map <-> blender Alpha Texture -- 3ds Self Illum Map <-> blender Emission Texture +- 3ds Self Illumination Map <-> blender Emission Texture - 3ds Bump Map <-> blender Normal Map (tangent space) -- 3ds Tex2 Map <-> blender Color Texture (connect to mixshader) +- 3ds Tex2 Map <-> blender Color Texture (connect to mix-shader) .. figure:: /images/addons_io_3ds_material-nodes.jpg @@ -140,12 +144,12 @@ Meshes ====== Meshes are made of triangles only, no quads are supported, -3ds Studio uses edge visibilty flags to hide and show edges, many 3ds files use them to mark the quads. +3ds Studio uses edge visibility flags to hide and show edges, many 3ds files use them to mark the quads. The Blender 3ds importer and exporter will use those flags to mark edges sharp, this can be used to convert the triangles back to quads. -The importer can read the smoothchunk and shades a face smooth if it belongs to a smoothgroup, +The importer can read the smooth-chunk and shades a face smooth if it belongs to a smooth-group, the exporter creates a smooth chunk if the mesh contains any smooth faces. -3ds only supports one pair of UV coordinates per vertex. If any vertex has more UVs, it will be dublicated. +3ds only supports one pair of UV coordinates per vertex. If any vertex has more UVs, it will be duplicated. Ambient @@ -178,3 +182,4 @@ Keyframes The importer can read the keyframes, they will be added to the timeline. Most animations will play, but the transformations may not be correct, some axes or rotations can be inverted. It depends on how it was exported from other applications. +The exporter can write the keyframes of the timeline to an animated 3ds file. diff --git a/manual/addons/import_export/scene_dxf.rst b/manual/addons/import_export/scene_dxf.rst index a30521b50..c205bfc76 100644 --- a/manual/addons/import_export/scene_dxf.rst +++ b/manual/addons/import_export/scene_dxf.rst @@ -6,7 +6,7 @@ AutoCAD DXF .. reference:: :Category: Import-Export - :Menu: :menuselection:`File --> Import/Export --> AutoCAD DXF` + :Menu: :menuselection:`File --> Import/Export --> AutoCAD DXF (.dxf)` .. _dxf-import: diff --git a/manual/addons/interface/amaranth.rst b/manual/addons/interface/amaranth.rst index aa1e3c0f4..7f5096b7a 100644 --- a/manual/addons/interface/amaranth.rst +++ b/manual/addons/interface/amaranth.rst @@ -330,7 +330,7 @@ Timeline Extra Info Display amount of frames left until Frame End, very handy especially when rendering an animation or OpenGL preview. -Display current/end time in `SMPTE `_. +Display current/end time in `SMPTE `__. Usage: Find it in the Timeline Editor's header. @@ -381,7 +381,7 @@ Sequencer: Display Image File Name When seeking through an image sequence, display the active strips' file name for the current frame, and its playhead (in square brackets). -Usage: Find it in the VSE header. +Usage: Find it in the sequencer header. EXR Render: Warn when Z not connected diff --git a/manual/addons/mesh/tissue.rst b/manual/addons/mesh/tissue.rst index e7bfb48c4..768c37fed 100644 --- a/manual/addons/mesh/tissue.rst +++ b/manual/addons/mesh/tissue.rst @@ -414,8 +414,8 @@ that generate the various patterns of many living organisms. See `this video `__ for an example of the Reaction-Diffusion simulation with Tissue. -Radom Materials ---------------- +Random Materials +---------------- (To Do) diff --git a/manual/addons/object/greasepencil_tools.rst b/manual/addons/object/greasepencil_tools.rst index 8bb114449..572913331 100644 --- a/manual/addons/object/greasepencil_tools.rst +++ b/manual/addons/object/greasepencil_tools.rst @@ -76,7 +76,7 @@ Timeline Scrub Call a timeline popup at mouse position to scrub without leaving the 3D viewport. Default shortcut to call the timeline is :kbd:`Alt-MMB`. -The shortcut enable the scrubbing when hovering timeline editors as well (dopesheet, sequencer, etc). +The shortcut enable the scrubbing when hovering timeline editors as well (dope-sheet, sequencer, etc). Scene start/end and keyframes are represented with symbols on the timeline. diff --git a/manual/advanced/command_line/arguments.rst b/manual/advanced/command_line/arguments.rst index 2c72d7c22..19576374c 100644 --- a/manual/advanced/command_line/arguments.rst +++ b/manual/advanced/command_line/arguments.rst @@ -1,6 +1,5 @@ .. DO NOT EDIT THIS FILE, GENERATED BY 'blender_help_extract.py' - CHANGES TO THIS FILE MUST BE MADE IN BLENDER'S SOURCE CODE, SEE: https://projects.blender.org/blender/blender/src/branch/main/source/creator/creator_args.c @@ -10,10 +9,8 @@ Command Line Arguments ********************** - -Blender |BLENDER_VERSION| -Usage: blender [args ...] [file] [args ...] - +| Blender |BLENDER_VERSION| +| Usage: ``blender [args ...] [file] [args ...]`` .. _command-line-args-render-options: @@ -22,10 +19,13 @@ Render Options ``-b``, ``--background`` Run in background (often used for UI-less rendering). + ``-a``, ``--render-anim`` Render frames from start to end (inclusive). + ``-S``, ``--scene`` ```` Set the active scene ```` for rendering. + ``-f``, ``--render-frame`` ```` Render frame ```` and save it. @@ -33,12 +33,16 @@ Render Options * A comma separated list of frames can also be used (no spaces). * A range of frames can be expressed using ``..`` separator between the first and last frames (inclusive). + ``-s``, ``--frame-start`` ```` Set start to frame ````, supports +/- for relative frames too. + ``-e``, ``--frame-end`` ```` Set end to frame ````, supports +/- for relative frames too. + ``-j``, ``--frame-jump`` ```` Set number of frames to step forward after each rendered frame. + ``-o``, ``--render-output`` ```` Set the render path and file name. Use ``//`` at the start of the path to render relative to the blend-file. @@ -57,13 +61,36 @@ Render Options blender -b animation.blend -o //render_ -F PNG -x 1 -a ``//render_`` becomes ``//render_####``, writing frames as ``//render_0001.png`` + ``-E``, ``--engine`` ```` Specify the render engine. Use ``-E help`` to list available engines. + ``-t``, ``--threads`` ```` Use amount of ```` for rendering and other operations [1-1024], 0 for systems processor count. +.. _command-line-args-cycles-render-options: + +Cycles Render Options +===================== + +Cycles add-on options must be specified following a double dash. + +``--cycles-device`` ```` + Set the device used for rendering. + Valid options are: ``CPU`` ``CUDA`` ``OPTIX`` ``HIP`` ``ONEAPI`` ``METAL``. + + Append +CPU to a GPU device to render on both CPU and GPU. + + Example: + + .. code-block:: sh + + blender -b file.blend -f 20 -- --cycles-device OPTIX + +``--cycles-print-stats`` + Log statistics about render memory and time usage. .. _command-line-args-format-options: @@ -73,10 +100,11 @@ Format Options ``-F``, ``--render-format`` ```` Set the render format. Valid options are: - ``TGA`` ``RAWTGA`` ``JPEG`` ``IRIS`` ``IRIZ`` ``AVIRAW`` ``AVIJPEG`` ``PNG`` ``BMP`` + ``TGA`` ``RAWTGA`` ``JPEG`` ``IRIS`` ``IRIZ`` ``AVIRAW`` ``AVIJPEG`` ``PNG`` ``BMP``. Formats that can be compiled into Blender, not available on all systems: - ``HDR`` ``TIFF`` ``OPEN_EXR`` ``OPEN_EXR_MULTILAYER`` ``MPEG`` ``CINEON`` ``DPX`` ``DDS`` ``JP2`` ``WEBP`` + ``HDR`` ``TIFF`` ``OPEN_EXR`` ``OPEN_EXR_MULTILAYER`` ``MPEG`` ``CINEON`` ``DPX`` ``DDS`` ``JP2`` ``WEBP``. + ``-x``, ``--use-extension`` ```` Set option to add the file extension to the end of the file. @@ -96,7 +124,7 @@ Animation Playback Options Open with lower left corner at ````, ````. ``-m`` Read from disk (Do not buffer). - ``-f`` ```` ```` + ``-f`` ```` ```` Specify FPS to start with. ``-j`` ```` Set frame step to ````. @@ -116,16 +144,22 @@ Window Options ``-w``, ``--window-border`` Force opening with borders. + ``-W``, ``--window-fullscreen`` Force opening in fullscreen mode. + ``-p``, ``--window-geometry`` ```` ```` ```` ```` Open with lower left corner at ````, ```` and width and height as ````, ````. + ``-M``, ``--window-maximized`` Force opening maximized. + ``-con``, ``--start-console`` Start with the console window open (ignored if ``-b`` is set), (Windows only). + ``--no-native-pixels`` Do not use native pixel size, for high resolution displays (MacBook ``Retina``). + ``--no-window-focus`` Open behind other windows and without taking focus. @@ -136,23 +170,31 @@ Python Options ============== ``-y``, ``--enable-autoexec`` - Enable automatic Python script execution (default). + Enable automatic Python script execution. + ``-Y``, ``--disable-autoexec`` - Disable automatic Python script execution (pydrivers & startup scripts). + Disable automatic Python script execution (pydrivers & startup scripts), (default). + ``-P``, ``--python`` ```` Run the given Python script file. + ``--python-text`` ```` Run the given Python script text block. + ``--python-expr`` ```` Run the given expression as a Python script. + ``--python-console`` Run Blender with an interactive console. + ``--python-exit-code`` ```` Set the exit-code in [0..255] to exit if a Python exception is raised (only for scripts executed from the command line), zero disables. + ``--python-use-system-env`` Allow Python to use system environment variables such as ``PYTHONPATH`` and the user site-packages directory. + ``--addons`` ```` Comma separated list (no spaces) of add-ons to enable in addition to any default add-ons. @@ -170,15 +212,20 @@ Logging Options so ``--log "*undo*"`` logs every kind of undo-related message. Use "^" prefix to ignore, so ``--log "*,^wm.operator.*"`` logs all except for ``wm.operators.*`` Use "*" to log everything. + ``--log-level`` ```` Set the logging verbosity level (higher for more details) defaults to 1, use -1 to log all levels. + ``--log-show-basename`` Only show file name in output (not the leading path). + ``--log-show-backtrace`` Show a back trace for each log message (debug builds only). + ``--log-show-timestamp`` Show a timestamp for each log message in seconds since start. + ``--log-file`` ```` Set a file to output the log to. @@ -194,73 +241,109 @@ Debug Options * Enables memory error detection * Disables mouse grab (to interact with a debugger in some cases) * Keeps Python's ``sys.stdin`` rather than setting it to None + ``--debug-value`` ```` Set debug value of ```` on startup. + ``--debug-events`` Enable debug messages for the event system. + ``--debug-ffmpeg`` Enable debug messages from FFmpeg library. + ``--debug-handlers`` Enable debug messages for event handling. + ``--debug-libmv`` Enable debug messages from libmv library. + ``--debug-cycles`` Enable debug messages from Cycles. + ``--debug-memory`` Enable fully guarded memory allocation and debugging. + ``--debug-jobs`` Enable time profiling for background jobs. + ``--debug-python`` Enable debug messages for Python. + ``--debug-depsgraph`` Enable all debug messages from dependency graph. + ``--debug-depsgraph-eval`` Enable debug messages from dependency graph related on evaluation. + ``--debug-depsgraph-build`` Enable debug messages from dependency graph related on graph construction. + ``--debug-depsgraph-tag`` Enable debug messages from dependency graph related on tagging. + ``--debug-depsgraph-no-threads`` Switch dependency graph to a single threaded evaluation. + ``--debug-depsgraph-time`` Enable debug messages from dependency graph related on timing. + ``--debug-depsgraph-pretty`` Enable colors for dependency graph debug messages. + ``--debug-depsgraph-uuid`` Verify validness of session-wide identifiers assigned to ID datablocks. + ``--debug-ghost`` Enable debug messages for Ghost (Linux only). + ``--debug-wintab`` Enable debug messages for Wintab. + ``--debug-gpu`` Enable GPU debug context and information for OpenGL 4.3+. + ``--debug-gpu-force-workarounds`` Enable workarounds for typical GPU issues and disable all GPU extensions. + ``--debug-gpu-disable-ssbo`` Disable usage of shader storage buffer objects. + ``--debug-gpu-renderdoc`` Enable Renderdoc integration for GPU frame grabbing and debugging. + ``--debug-wm`` Enable debug messages for the window manager, shows all operators in search, shows keymap errors. + ``--debug-xr`` Enable debug messages for virtual reality contexts. Enables the OpenXR API validation layer, (OpenXR) debug messages and general information prints. + ``--debug-xr-time`` Enable debug messages for virtual reality frame rendering times. + ``--debug-all`` Enable all debug messages. + ``--debug-io`` Enable debug messages for I/O (Collada, ...). + ``--debug-fpe`` Enable floating-point exceptions. + ``--debug-exit-on-error`` Immediately exit when internal errors are detected. + +``--debug-freestyle`` + Enable debug messages for Freestyle. + ``--disable-crash-handler`` Disable the crash handler. + ``--disable-abort-handler`` Disable the abort handler. + ``--verbose`` ```` Set the logging verbosity level for debug messages that support it. @@ -281,49 +364,60 @@ Misc Options ``--open-last`` Open the most recently opened blend file, instead of the default startup file. + ``--app-template`` ``