From a61d5a983df99292846595e78a3673a3a3ed6337 Mon Sep 17 00:00:00 2001 From: Michael Davies Date: Wed, 15 Jun 2016 14:32:15 +1000 Subject: [PATCH] Added proper readme --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 515c57f..77a0eed 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,36 @@ # Spaceship Generator -A Blender script to procedurally generate 3D spaceships. -Source code to come in the next few days once I've cleaned it up. +A Blender script to procedurally generate 3D spaceships from a random seed. + +![alt tag](https://raw.githubusercontent.com/a1studmuffin/SpaceshipGenerator/master/screenshots/spaceships_grid.jpg) + +Usage +----- +* Install Blender: http://blender.org/download/ +* Open a *Text Editor* view +* Press *Alt + O*, or go to *Text > Open Text Block* and open `spaceship_generator.py` +* Press *Alt + P* or click *Run script* + +How it works +------------ +* Start with a box. +* Build the hull: Extrude the front/rear faces several times, adding random translation/scaling/rotation along the way. +* Add asymmetry to the hull: Pick random faces and extrude them out in a similar manner, reducing in scale each time. +* Add detail to the hull: Categorize each face by its orientation and generate details on it such as engines, antenna, weapon turrets, lights etc. +* Sometimes apply horizontal symmetry. +* Add a Bevel modifier to angularize the shape a bit. +* Apply materials to the final result. +* Take over the universe with your new infinite fleet of spaceships. + +Credits +------- +Written for fun as part of the [/r/proceduralgeneration](https://www.reddit.com/r/proceduralgeneration/) June 2016 [monthly challenge](https://www.reddit.com/r/proceduralgeneration/comments/4mn9gj/monthly_challenge_7_june_2016_procedural/). + +Released under the [MIT License]. + +Authored and maintained by Michael Davies. + +> GitHub [@a1studmuffin](https://github.com/a1studmuffin) +> Twitter [@butterparty](https://twitter.com/butterparty) + +[MIT License]: http://mit-license.org/