Add toolbar.blend update instructions #50

Sean Kim · 2024-04-20T02:21:15+02:00

Sean Kim commented

2024-04-20 02:21:15 +02:00

As suggested in blender/blender-assets#4, this PR migrates the existing in-file README.txt to the wiki to support easier updates and overall accessibility. A future PR will update the toolbar.blend README to point to this section of the document.

The added text in icons.md does not match up 1:1 to the existing README, minor changes have been done to improve readability

Current README.txt

About Geometry Icons
====================

* All icons are generated from this file.

* X,Y vertex locations from -1 to 1 are used.

* Output stored in "${BLENDER}/release/datafiles/icons".


Exporting
---------

* Only mesh objects are exported.

* Icons must be in the collection "Export"
  to be considered for exporting.

* Object names are used to generate filenames
  eg: "ops.gpencil.draw.eraser" will be written to
  "${BLENDER}/release/datafiles/icons/ops.gpencil.draw.eraser.dat"

* An objects children are recursively included when exporting
  to allow easily sharing geometry between icons.
  Note, these need to be part of the "Export" collection too.

  These may be transformed as long as they remain in the icon bounds.
  
* Material colors are multiplied by vertex colors when exporting.

* Geometry depth is used so closer faces draw on top.

* Vertex alpha can be used.


Export Process
--------------

On Linux/macos you can run:
   make icons_geom

From the build directory to generate icons, see "make help" for details.

This generates icons and adds them to CMakeLists.txt for committing.


Notes
-----

* Keep icon detail low since more complex icons
  will take more time to draw (while cached, avoid unnecessary overhead).
  
* Try to keep this file well organized.

As suggested in blender/blender-assets#4, this PR migrates the existing in-file `README.txt` to the wiki to support easier updates and overall accessibility. A future PR will update the `toolbar.blend` README to point to this section of the document. The added text in `icons.md` does not match up 1:1 to the existing README, minor changes have been done to improve readability ### Current README.txt ``` About Geometry Icons ==================== * All icons are generated from this file. * X,Y vertex locations from -1 to 1 are used. * Output stored in "${BLENDER}/release/datafiles/icons". Exporting --------- * Only mesh objects are exported. * Icons must be in the collection "Export" to be considered for exporting. * Object names are used to generate filenames eg: "ops.gpencil.draw.eraser" will be written to "${BLENDER}/release/datafiles/icons/ops.gpencil.draw.eraser.dat" * An objects children are recursively included when exporting to allow easily sharing geometry between icons. Note, these need to be part of the "Export" collection too. These may be transformed as long as they remain in the icon bounds. * Material colors are multiplied by vertex colors when exporting. * Geometry depth is used so closer faces draw on top. * Vertex alpha can be used. Export Process -------------- On Linux/macos you can run: make icons_geom From the build directory to generate icons, see "make help" for details. This generates icons and adds them to CMakeLists.txt for committing. Notes ----- * Keep icon detail low since more complex icons will take more time to draw (while cached, avoid unnecessary overhead). * Try to keep this file well organized. ```

Sean Kim added 1 commit 2024-04-20 02:21:16 +02:00

Add toolbar.blend update instructions d3813b159a

Sean Kim requested review from Pablo Vazquez 2024-04-20 02:21:27 +02:00

Pablo Vazquez commented

2024-04-25 19:05:43 +02:00

Thanks for working on it!

Pablo Vazquez approved these changes 2024-04-25 19:05:51 +02:00

Brecht Van Lommel merged commit 2ded1fc05d into main

2024-04-26 17:29:24 +02:00

Brecht Van Lommel deleted branch toolbar-blend-readme

2024-04-26 17:29:24 +02:00

Brecht Van Lommel referenced this issue from a commit