Difference between revisions of "Documentation:Index"

From MakeHuman Community Wiki
Jump to: navigation, search
m
(Instructions)
Line 1: Line 1:
 
Start page for documentation
 
Start page for documentation
 +
 +
Start page for documentation
 +
 +
== Introduction ==
 +
== MakeHuman™ and its Purpose MakeHuman definition and vision. ==
 +
=== Short and Long Pipeline The goal of Makehuman is to see it used in 2 different professional pipelines. ===
 +
=== Professional mesh topology An overview of the professional topology provided by MakeHuman ===
 +
=== Legal The various licenses that apply to MakeHuman and External tools ===
 +
== General overview ==
 +
=== Install MakeHuman™ How to install MH on Windows, Osx and Linux. ===
 +
The Interface and basic functions. The MakeHuman GUI: Load, save, undo and redo, reset, view, symmetry, help.===
 +
=== Zoom, pan and rotate using the orbital camera Navigating the scene using the orbital camera.===
 +
=== Load Save and Export Describe file actions for MakeHuman===
 +
== Define Human Characteristics ==
 +
Parametric Modelling A quick introduction to the parametric modelling and sliders usage.===
 +
Using MakeHuman Hairstyles and Clothes Hair in the MakeHuman Geometries group ===
 +
Skin and other materials How to change skin and materials for hair and clothes.===
 +
Gender, Random, Measure and Custom Special modifiers.===
 +
Makehuman alternative topologies MakeHuman provides a smart alternative topologies library ===
 +
== Rendering Your Work ==
 +
Quick rendering and advanced rendering This section explains how render the character in MakeHuman ===
 +
Scene and Viewer How to set lights and how to see and save the rendering ===
 +
== Settings ==
 +
General How to set the general preferences ===
 +
Background How to use backgrounds for reference.===
 +
Mouse Explanation of mouse settings ===
 +
Shortcuts Configuration of shortcuts in Makehuman ===
 +
Plugins Management of Makehuman plugins ===
 +
==  Tools and contributing methods ==
 +
MHBlenderTools: Download and installation How to download and install the addons for Blender ===
 +
MHBlenderTools: MakeTarget Description of MakeTarget™ tool, to create custom morphings for MakeHuman. ===
 +
MHBlenderTools: MakeClothes Description of MakeClothes and its user interface.===
 +
MHBlenderTools: MakeWalk basic workflow MakeWalk is a Blender add-on for retargeting mocap data (.bvh files) to a given armature. ===
 +
MHBlenderTools: MakeWalk user interface Description of the GUI integrated in Blender. ===
 +
MHBlenderTools: MakeWalk armatures Explain the meaning and use of source and target armature. ===
 +
MHBlenderTools: MakeWalk utilities Utilities: save and restore the defaults, manage actions, t-pose, etc. ===
 +
MHBlenderTools: MakeWalk troubleshooting. This document will describe common errors and corrective actions. ===
 +
MHBlenderTools: MHX importer basic usage. MHX (MakeHuman eXchange format) is a custom format used to transfer a rigged character from MakeHuman to Blender. ===
 +
MHBlenderTools: MHX default rigging If pose/animate > skeleton is set to 'None' when the character is exported from MakeHuman in .mhx format, the character is equipped with the default MHX armature. This is a rather complex rig with quite a few features.
 +
MHBlenderTools: MHX other rigging systems The character can be rigged with alternatives and ligher armature or the rigify one (The rigging system for Blender devoped by Nathan Vegdahl). ===
 +
MHBlenderTools: MHX Layers and masks The mhx importer creates objects on the first four layers. ===
 +
MakeTarget standalone Converting files produced with the most common modelling software, without Blender.===
 +
GUI languages and translations. MakeHuman support a variety of languages. It's very easy to add translations.===
 +
== Reporting a Bug ==
 +
Using the Makehuman bug tracker Introduction to the new Makehuman bug tracker ===
 +
Using the Makehuman log files for error reporting How to report bugs using the log files. ===
 +
== Developers' note ==
 +
Getting started The best way to start your experiments with MakeHuman code is to clone our official repository and start to modify it. ===
 +
Development infrastructure A description of the MakeHuman development infrastructure. ===
 +
OpenGL Notes Most of the 3D mesh handling functionality is delivered using OpenGL embedded within the C application code. ===
 +
Development organization The organization of distributed development. ===
 +
Libraries and build procedures Describes the details of creating installable packages on major platforms ===
 +
Directory structure and core modules Summary of the MH API reference. ===
 +
File formats and extensions Describes the formats used internally for data and object storage. [CRUDE NOTES} ===
 +
Makehuman Plugin System How to make a new plugin and use it in MakeHuman ===
 +
== Packager's notes ==
 +
Packaging RPM's for Suse/Fedora using Open Build Service (OBS) Packaging procedure and setup. ===
 +
== Tutorials ==
 +
Tutorial MH1.0 alpha8 ===
 +
[Alpha8] Making diapers for a baby. A tutorial illustrating the MakeClothes workflow. ===
 +
MakeClothes: Making a simple dress The basic MakeClothes workflow. ===
 +
MakeClothes: Controlling the result with vertex groups The output of the clothes-making process depends on how vertex groups are assigned. ===
 +
Creating a Custom Target with MakeTarget Standalone A practical example of custom target ===
 +
MakeWalk: The making of Running feet MakeWalk tutorial, focusing on the Edit Action panel. ===
 +
MakeWalk: Running feet scene 1 Making an extended run on a plane. ===
 +
MakeWalk: Running feet scene 2 High heels and slopes. ===
 +
MakeWalk: Running feet scene 3 The race. ===
 +
MakeWalk: Running feet scene 4 Rough terrain. ===
 +
MakeWalk: Automatic animation Tutorial on using the editing tools in MakeWalk. ===
 +
  
 
== Instructions ==
 
== Instructions ==
  
 
Please put all documentation nodes in namespace "Documentation", like <nowiki>[[Documentation:Introduction to the interface|Introduction to the interface]]</nowiki> (which would resolve as [[Documentation:Introduction to the interface|Introduction to the interface]])
 
Please put all documentation nodes in namespace "Documentation", like <nowiki>[[Documentation:Introduction to the interface|Introduction to the interface]]</nowiki> (which would resolve as [[Documentation:Introduction to the interface|Introduction to the interface]])

Revision as of 20:16, 29 June 2015

Start page for documentation

Start page for documentation

Introduction

MakeHuman™ and its Purpose MakeHuman definition and vision.

Short and Long Pipeline The goal of Makehuman is to see it used in 2 different professional pipelines.

Professional mesh topology An overview of the professional topology provided by MakeHuman

Legal The various licenses that apply to MakeHuman and External tools

General overview

Install MakeHuman™ How to install MH on Windows, Osx and Linux.

The Interface and basic functions. The MakeHuman GUI: Load, save, undo and redo, reset, view, symmetry, help.===

Zoom, pan and rotate using the orbital camera Navigating the scene using the orbital camera.

Load Save and Export Describe file actions for MakeHuman

Define Human Characteristics

Parametric Modelling A quick introduction to the parametric modelling and sliders usage.=== Using MakeHuman Hairstyles and Clothes Hair in the MakeHuman Geometries group === Skin and other materials How to change skin and materials for hair and clothes.=== Gender, Random, Measure and Custom Special modifiers.=== Makehuman alternative topologies MakeHuman provides a smart alternative topologies library ===

Rendering Your Work

Quick rendering and advanced rendering This section explains how render the character in MakeHuman === Scene and Viewer How to set lights and how to see and save the rendering ===

Settings

General How to set the general preferences === Background How to use backgrounds for reference.=== Mouse Explanation of mouse settings === Shortcuts Configuration of shortcuts in Makehuman === Plugins Management of Makehuman plugins ===

Tools and contributing methods

MHBlenderTools: Download and installation How to download and install the addons for Blender === MHBlenderTools: MakeTarget Description of MakeTarget™ tool, to create custom morphings for MakeHuman. === MHBlenderTools: MakeClothes Description of MakeClothes and its user interface.=== MHBlenderTools: MakeWalk basic workflow MakeWalk is a Blender add-on for retargeting mocap data (.bvh files) to a given armature. === MHBlenderTools: MakeWalk user interface Description of the GUI integrated in Blender. === MHBlenderTools: MakeWalk armatures Explain the meaning and use of source and target armature. === MHBlenderTools: MakeWalk utilities Utilities: save and restore the defaults, manage actions, t-pose, etc. === MHBlenderTools: MakeWalk troubleshooting. This document will describe common errors and corrective actions. === MHBlenderTools: MHX importer basic usage. MHX (MakeHuman eXchange format) is a custom format used to transfer a rigged character from MakeHuman to Blender. === MHBlenderTools: MHX default rigging If pose/animate > skeleton is set to 'None' when the character is exported from MakeHuman in .mhx format, the character is equipped with the default MHX armature. This is a rather complex rig with quite a few features. MHBlenderTools: MHX other rigging systems The character can be rigged with alternatives and ligher armature or the rigify one (The rigging system for Blender devoped by Nathan Vegdahl). === MHBlenderTools: MHX Layers and masks The mhx importer creates objects on the first four layers. === MakeTarget standalone Converting files produced with the most common modelling software, without Blender.=== GUI languages and translations. MakeHuman support a variety of languages. It's very easy to add translations.===

Reporting a Bug

Using the Makehuman bug tracker Introduction to the new Makehuman bug tracker === Using the Makehuman log files for error reporting How to report bugs using the log files. ===

Developers' note

Getting started The best way to start your experiments with MakeHuman code is to clone our official repository and start to modify it. === Development infrastructure A description of the MakeHuman development infrastructure. === OpenGL Notes Most of the 3D mesh handling functionality is delivered using OpenGL embedded within the C application code. === Development organization The organization of distributed development. === Libraries and build procedures Describes the details of creating installable packages on major platforms === Directory structure and core modules Summary of the MH API reference. === File formats and extensions Describes the formats used internally for data and object storage. [CRUDE NOTES} === Makehuman Plugin System How to make a new plugin and use it in MakeHuman ===

Packager's notes

Packaging RPM's for Suse/Fedora using Open Build Service (OBS) Packaging procedure and setup. ===

Tutorials

Tutorial MH1.0 alpha8 === [Alpha8] Making diapers for a baby. A tutorial illustrating the MakeClothes workflow. === MakeClothes: Making a simple dress The basic MakeClothes workflow. === MakeClothes: Controlling the result with vertex groups The output of the clothes-making process depends on how vertex groups are assigned. === Creating a Custom Target with MakeTarget Standalone A practical example of custom target === MakeWalk: The making of Running feet MakeWalk tutorial, focusing on the Edit Action panel. === MakeWalk: Running feet scene 1 Making an extended run on a plane. === MakeWalk: Running feet scene 2 High heels and slopes. === MakeWalk: Running feet scene 3 The race. === MakeWalk: Running feet scene 4 Rough terrain. === MakeWalk: Automatic animation Tutorial on using the editing tools in MakeWalk. ===


Instructions

Please put all documentation nodes in namespace "Documentation", like [[Documentation:Introduction to the interface|Introduction to the interface]] (which would resolve as Introduction to the interface)