From 759568d262b15b7780971baa4c521dc459b41cef Mon Sep 17 00:00:00 2001
From: Chris Sprance <chrissprance@gmail.com>
Date: Tue, 5 Mar 2019 13:48:20 -0500
Subject: [PATCH] Create README.md

---
 README.md | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 129 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3482e88
--- /dev/null
+++ b/README.md
@@ -0,0 +1,129 @@
+## All of these scripts can be run by going to View → Open View Pane → "Python Scripts" and then select the script and click execute (or double click the script). Some scripts may have dedicated toolbars which you can find by right clicking on the toolbar and Choosing the appropriate toolbar as documented below
+
+* * *
+
+# CaptureMovie Toolbar
+
+![](https://csprance.com/shots/2018-11-07_6231ae5d-8679-4a6a-8491-e333f588f905.png)
+
+## Setup Movie
+
+Asks the user a series of questions that configure some options for capturing a video in the editor. Opens the outputfolder so you can watch the frames as they come in
+
+## Start Recording
+
+Starts capturing frames and plays a trackview at the same time
+
+## Stop Recording
+
+Stops an playing trackview and stops any capturing of frames
+
+* * *
+
+# <u>[Creating Item Icons](#)</u>  - Icon Toolbar
+
+Guide on how to create icons for item files available by clicking link above
+
+* * *
+
+# distribute_objects.py - Distribute Toolbar
+
+With one or m ore brushes selected choose a plane to distribute the objects randomly along that plane. 
+
+![](https://csprance.com/shots/2018-10-03_f68e2aad-47d2-4f69-94d6-8d0b9436cd7b.gif)
+
+* * *
+
+# simulatebrush.py - Transformation Toolbar
+
+With a single brush selected run the script to convert it to a rigid body, and simulate the rigid body.
+
+After the simulation run the script again to convert it back to a brush
+
+![](https://csprance.com/shots/2018-06-12_cc4e70bb-c798-4136-a9e0-5b2cf9b32320.gif)
+
+* * *
+
+## rotate_randomly.py - Transformation Toolbar
+
+Randomly rotate all selected items.
+
+![](https://csprance.com/shots/2018-06-11_5dd5fe6c-20ed-482c-ba4a-01845ee8b63a.gif)
+
+* * *
+
+## unrotate.py  - Transformation Toolbar
+
+Set the rotation to (0,0,0) on all selected objects
+
+![](https://csprance.com/shots/2018-06-11_29a6dcbc-12c8-4f3d-9856-cc5d2a94eff3.gif)
+
+* * *
+
+## align_items.py - Alignment Toolbar
+
+Aligns selected objects to a specific axis
+
+(Run using the buttons on the Alignment Toolbar)
+
+![](https://csprance.com/shots/2018-06-12_72962f8d-de08-4e3e-a416-09742175d289.gif)
+
+* * *
+
+## xform_copy.py - Transformation Toolber
+
+Copy a single items xforms to be used elsewhere
+
+(Run using the Copy Xforms button on the Transformation Toolbar)
+
+![](https://csprance.com/shots/2018-06-12_ad593b1a-b400-4486-aa66-6f4aaaefa974.gif)
+
+* * *
+
+## xform_paste.py - Transformation Toolbar
+
+Pastes copied xforms to a single selected item
+
+(Run using the Paste Xforms buttons on the Transformation Toolbar)
+
+![](https://csprance.com/shots/2018-06-12_ad593b1a-b400-4486-aa66-6f4aaaefa974.gif)
+
+* * *
+
+## grabentities.py - EiTools Toolbar
+
+Add one or more entities to the level by xml file
+
+![](https://csprance.com/shots/2018-06-12_1f57b8ce-7c60-4672-b3bb-f22818b7f626.gif)
+
+* * *
+
+## grab_cgfs_from_folder.py - EiTools Toolbar
+
+Add one or more cgf files to the level by cgf file
+
+![](https://csprance.com/shots/2018-06-12_30d3c184-ecee-42c6-8c1d-fb32437011b8.gif)
+
+* * *
+
+## kill_editor.py - EiTools Toolbar
+
+Instantly kill the editor
+
+![](https://csprance.com/shots/2018-06-12_178e5660-ff65-41c2-b7c5-ac365152d0ff.gif)
+
+* * *
+
+## open_in_expolrer.py - EiTools Toolbar
+
+View the currently selected brush's cgf in windows explorer
+
+![](https://csprance.com/shots/2018-06-12_697c2772-ffd8-40c1-9cbd-bc082e551577.gif)
+
+* * *
+
+## take_screenshot.py - EiTools Toolbar
+
+Take a screenshot and open the screenshots folder
+
+![](https://csprance.com/shots/2018-06-12_4f543d7b-2321-4ad8-9fff-0aa2788672ba.gif)