URCHN Arkipelago Difference between revisions of "Blendflakes"

Difference between revisions of "Blendflakes"

From URCHN Arkipelago
(Created page with " == Introduction == This is a simple script that, like pyflakes for python scripts, checks a Blendfile for 'niceness' From our perspective, it does checks that make it easier for...")
 
Line 1: Line 1:
 
 
== Introduction ==
 
== Introduction ==
 
This is a simple script that, like pyflakes for python scripts, checks a Blendfile for 'niceness'
 
This is a simple script that, like pyflakes for python scripts, checks a Blendfile for 'niceness'
Line 7: Line 6:
  
 
errors/warnings are written to libraryfile.err
 
errors/warnings are written to libraryfile.err
 +
 +
== Installation and Usage ==
 +
=== Installation ===
 +
* Start a new file and go to the User Preferences, select the Addons tab, and click on "Install Addon..." in the lower part of the window.
 +
* Browse to the file blendflakes.py (usually in tubeSVN/lib/python/addons,) select it and hit Enter
 +
* Check the activation box next to the addon, and then press "Save As Default" at the bottom of the window.
 +
=== Usage ===
 +
* Open a model file you want to check.
 +
* Press 'w' and select Show Warnings/Errors in library file (you can also use the spacebar search)
 +
* Blender will output all warnings by default, and select offending objects.
 +
* If you use w and want to change options, do so in the last operator region in the toolbar, then press w again (If you use spacebar search you will get a popup anyway)
 +
* warnings are shown in the info area (drag down the header)
 +
* if export is checked, they are saved to libraryfile.err (where libraryfile is the name of your .blend file)
 +
* If you have a lot of warnings you might want to uncheck some of them and tackle them a few at a time.
 +
 +
== List of Warnings ==
 +
Following is a list of the things we check for:
 +
 +
== Future work ==

Revision as of 18:18, 25 January 2012

Introduction

This is a simple script that, like pyflakes for python scripts, checks a Blendfile for 'niceness' From our perspective, it does checks that make it easier for people to understand/use each other's library files, and uses/enforces/creates a text description file with the same name, so that we can describe our groups:

libraryfile.blend and libraryfile.txt

errors/warnings are written to libraryfile.err

Installation and Usage

Installation

  • Start a new file and go to the User Preferences, select the Addons tab, and click on "Install Addon..." in the lower part of the window.
  • Browse to the file blendflakes.py (usually in tubeSVN/lib/python/addons,) select it and hit Enter
  • Check the activation box next to the addon, and then press "Save As Default" at the bottom of the window.

Usage

  • Open a model file you want to check.
  • Press 'w' and select Show Warnings/Errors in library file (you can also use the spacebar search)
  • Blender will output all warnings by default, and select offending objects.
  • If you use w and want to change options, do so in the last operator region in the toolbar, then press w again (If you use spacebar search you will get a popup anyway)
  • warnings are shown in the info area (drag down the header)
  • if export is checked, they are saved to libraryfile.err (where libraryfile is the name of your .blend file)
  • If you have a lot of warnings you might want to uncheck some of them and tackle them a few at a time.

List of Warnings

Following is a list of the things we check for:

Future work