Editing The Eggbot Extensions

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
{{EggBotDocs281}}
+
{{EggBotDocs210}}
  
  
 
The Eggbot Extensions || [[Eggbot Control|Eggbot Control >>>]]
 
The Eggbot Extensions || [[Eggbot Control|Eggbot Control >>>]]
  
 +
----
  
 +
'''Note:''' This page assumes that you are using v2.1 or later of the Eggbot extensions.  For v2.0 and earlier, see the [[The Eggbot Extensions v20|v2.0 extensions page]].
  
[http://inkscape.org/ Inkscape] interacts with your Eggbot through a collection of special "extensions" (plugins that extend the capabilities of Inkscape).  To see the Eggbot extensions you have installed, launch Inkscape.  Once Inkscape is running, pull down the "Extensions" menu.  That will show you categories of extensions which are installed.  By selecting the "EggBot" category, you can then see the list of supported Eggbot extensions and select one to use,
 
  
{{sized-external-image|521px|https://cdn.evilmadscientist.com/wiki/eggbot/extensiontut/ext1_menu.jpg}}
+
[http://inkscape.org/ Inkscape] interacts with your Eggbot through a collection of  "extensions" [1]. Inkscape extensions are simply pieces of software that extend the capabilities of Inkscape. Extensions have been so successful that Inkscape now ships with over a hundred.  Additional extensions can be provided by third-parties.  The Eggbot extensions are a case in point: they are Inkscape extensions provided by the Eggbot community.  The primary purpose of the Eggbot extensions is to extend Inkscape by allowing it to "print" to your Eggbot.
  
  
If you do not see "EggBot" listed in your extensions menu, see the Troubleshooting section below.
+
To see which Eggbot extensions you have installed, launch Inkscape.  Once Inkscape is running, pull down the "Extensions" menu.  That will show you categories of extensions which are installed.  By selecting the "EggBot" category, you can then see the list of supported Eggbot extensions and select one to use,
 +
 
 +
http://evilmadscience.s3.amazonaws.com/wiki/eggbot/extensiontut/extensions-intro-v210-01.png
 +
 
 +
If you do not see "EggBot" listed as an extension category, see the Troubleshooting section below.
  
 
A second category of Eggbot extensions -- "EggBot Contributed" -- should also appear.  These are unsupported extensions contributed by members of the Eggbot Community.
 
A second category of Eggbot extensions -- "EggBot Contributed" -- should also appear.  These are unsupported extensions contributed by members of the Eggbot Community.
Line 17: Line 22:
 
In the pages which follow, each of the following Eggbot extensions will be presented in detail,
 
In the pages which follow, each of the following Eggbot extensions will be presented in detail,
  
* [[Eggbot Control|Eggbot Control]] -- The controls for sending your drawings to your Eggbot
+
* EggBot
* [[Hatch fill]] -- Generate hatch and crosshatch fills
+
** [[Eggbot Control|Eggbot Control]] -- The controls for sending your drawings to your Eggbot
* [[Hershey_Text|Hershey Text]] -- Replace text with single-stroke engraving fonts
+
** [[Preset hatch for fills]] -- Automate setting the many parameters for Inkscape's "Hatches (rough)"
* [[Preset hatch for fills]] -- Automate setting the many parameters for Inkscape's "Hatches (rough)"
+
** [[Reorder Paths for Speed]] -- Optimize your drawing for faster plotting
* [[Reorder Paths for Speed]] -- Optimize your drawing for faster plotting
+
** [[Strip Eggbot Data]] -- Remove Eggbot control data from your drawing
* [[Stretch]] -- Circumferentially stretch your drawing for plotting on spherical surfaces
+
 
 +
* EggBot Contributed
 +
** [[Eggmazing]] -- Make cylindrical mazes for drawing on eggs
 +
** [[Hatch fill]] -- Generate hatch and crosshatch fills
 +
** [[Name Poem]] -- Render name poems using fonts suitable for use with the Eggbot
 +
** [[Post process trace bitmap]] -- Make Inkscape's "Trace Bitmap" output more suitable for Eggbot plotting
 +
** [[Spiral Wrapped Text]] -- Gently spiral text around and around an egg
 +
** [[Stretch]] -- Circumferentially stretch your drawing for plotting on spherical surfaces
 +
** [[Twist]] -- Sample extension code
 +
** '''Your extension here?'''
 +
 
 +
The truly aswesome thing about Inkscape extensions is that you can write your own and share them with others.  The only pre-requisite is learning a language called Python [2, 3].  You can see the source code to the Inkscape extensions by locating the extensions subdirectory in your Inkscape installation directory.  Each extension is a file whose name ends with ".py".  They are ordinary text files and no special tools are needed to read them.  They can be written with a simple text editor.
  
  
Some additional EggBot utilities are available [https://github.com/evil-mad/EggBot/tree/master/inkscape_contributed in our repository] for manual installation
+
== Where to find the extensions on your system ==
* [[Eggmazing]] -- Make cylindrical mazes for drawing on eggs
 
* [[Post process trace bitmap]] -- Make Inkscape's "Trace Bitmap" output more suitable for Eggbot plotting
 
* [[Twist]] -- Create geometric designs
 
  
 +
Eggbot's extensions to Inkscape are text files.  There are two text files per extension: a Python program with file extension .py and a menu description with file extension .inx.  The syntax of the latter file is that of XML while its semantics are specific to Inkscape [3].  These files are located in different directories on different platforms:
 +
 +
* Linux: ~/.config/inkscape/extensions/
 +
* Mac OS X: /Applications/Inkscape.app/Contents/Resources/extensions/
 +
* Windows: C:\Program Files\Inkscape\share\extensions\
  
  
 
== Troubleshooting ==
 
== Troubleshooting ==
  
If you do not see an "Eggbot" entry in your Inkscape extensions menu, then you likely have not yet installed the Eggbot software.  Please see [[Installing software]] for directions.  Another possibility is that you have more than one version of Inkscape installed and you are running the wrong copy.   
+
If you do not see the Eggbot extension category, then you likely have not yet installed the Eggbot software.  Please see [[Installing software]] for directions.  Another possibility is that you have more than one version of Inkscape installed and you are running the wrong copy.  Linux systems may come with Inkscape pre-installed.  If you upgraded the Inkscape on your system, it is possible that the newer copy did not replace the older copy and you now have two copies installed.
 +
 
  
 +
== Notes ==
  
 +
[1] Presently, Inkscape only interacts with your Eggbot hardware through a single extension, "Eggbot Control."  The other Eggbot extensions are tools which allow you to produce or modify Inkscape documents for use with your Eggbot.<br/>
 +
[2] There are many online Python tutorials including the one maintained by the Python organization, [http://docs.python.org/tutorial/ The Python Tutorial].<br/>
 +
[3] The Inkscape project provides some limited documentation on writing extensions at their wiki site.  See the "Extensions" topic under the "Developer tutorials" section at their  [http://wiki.inkscape.org/wiki/index.php/Inkscape main wiki page].  Studying existing extensions is a good way of supplementing the material found at the Inkscape wiki.<br/>
 
----
 
----
  
 
The Eggbot Extensions || [[Eggbot Control|Eggbot Control >>>]]
 
The Eggbot Extensions || [[Eggbot Control|Eggbot Control >>>]]

Please note that all contributions to Evil Mad Scientist Wiki are considered to be released under the GNU Free Documentation License 1.3 (see Evil Mad Scientist Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)