Difference between revisions of "Documentation:Index"

From MakeHuman Community Wiki
Jump to: navigation, search
(Documentation for developers)
(38 intermediate revisions by 3 users not shown)
Line 1: Line 1:
These are documentation fragments which have been ported. They may still miss some images
 
  
 
== Introduction ==
 
== Introduction ==
{| cellspacing="11" style="width:100%;"
+
 
|-style="vertical-align:top;"
+
* [[Documentation:What is MakeHuman?|What is MakeHuman?]]: A quick introduction to MakeHuman.
| style="width:33%;background-color: #E6EEE6; padding:.5em;"|
+
* [[Documentation:Short and Long Pipeline|Short and Long Pipeline ]]: The goal of Makehuman is to see it used in 2 different professional pipelines.  
* [[Documentation:MakeHuman™ and its Purpose|MakeHuman™ and its Purpose  ]]: MakeHuman definition and vision.
+
* [[Documentation:Professional mesh topology|Professional mesh topology ]]: An overview of the professional topology provided by MakeHuman
* [[ Documentation:Short and Long Pipeline|Short and Long Pipeline ]]: The goal of Makehuman is to see it used in 2 different professional pipelines.  
+
* [[Documentation:Legal|Legal ]]: The various licenses that apply to MakeHuman and External tools
* [[ Documentation:Professional mesh topology|Professional mesh topology ]]: An overview of the professional topology provided by MakeHuman
+
* [[ Documentation:Legal|Legal ]]: The various licenses that apply to MakeHuman and External tools
+
|}
+
  
 
== General overview ==
 
== General overview ==
  
None
+
* [[Documentation:Installing MakeHuman|Installing MakeHuman]]
 +
* [[Documentation:Running MakeHuman from source|Running MakeHuman from source]]
 +
* [[Documentation:Configuration and settings|Configuration and settings]]
 +
* [[Documentation:The interface and its basic functions|The interface and its basic functions]]
 +
* [[Documentation:The toolbar|The toolbar]]
 +
* [[Documentation:The tabs|The tabs]]
 +
* [[Documentation:The sliders|The sliders]]
 +
* [[Documentation:Loading and saving|Loading and saving]]
 +
* [[Documentation:Zoom, pan and rotate using the orbital camera|Zoom, pan and rotate using the orbital camera]]
  
== Defining human characteristics ==
+
== Working with the human ==
  
None
+
* [[Documentation:Gender, Random, Measure and Custom|Gender, Random, Measure and Custom]]
 +
* [[Documentation:Hairstyles and Clothes|Hairstyles and Clothes]]
 +
* [[Documentation:Modeling the body|Modeling the body]]
 +
* [[Documentation:Alternative topologies|Alternative topologies]]
 +
* [[Documentation:Skin and other materials|Skin and other materials]]
 +
* [[Documentation:Rendering your work|Rendering your work]]
  
== Rendering your work ==
+
== Exporting your work to another application ==
  
None
+
* [[Documentation:Exports and file formats|Exports and file formats]]
 +
* [[Documentation:Saving models for Blender and how to import them there|Saving models for Blender and how to import them there]]
 +
* [[Documentation:Saving models for Maya and how to import them there|Saving models for Maya and how to import them there]]
 +
* [[Documentation:Saving models for 3ds MAX and how to import them there|Saving models for 3ds MAX and how to import them there]]
 +
* [[Documentation:Saving models for Unreal Engine and how to import them there|Saving models for Unreal Engine and how to import them there]]
 +
* [[Documentation:Saving models for Unity and how to import them there|Saving models for Unity and how to import them there]]
 +
* [[Documentation:Saving models for OpenSim / Second Life and how to import them there|Saving models for OpenSim / Second Life and how to import them there]]
  
== Settings ==
+
== Working with MakeHuman models in Blender ==
  
None
+
* [[Documentation:Corrective shape keys|Corrective shape keys]]
  
== Blender tools ==
+
== Downloading or creating new assets ==
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #E6E6E6; padding:.5em;"|
+
* [[ Documentation:MHBlenderTools: Download and installation|MHBlenderTools: Download and installation ]]: How to download and install the addons for Blender
+
* [[ Documentation:MHBlenderTools: MakeTarget|MHBlenderTools: MakeTarget ]]: Description of the MakeTarget™ tool, to create custom morphings for MakeHuman.
+
* [[ Documentation:MHBlenderTools:MakeClothes|MHBlenderTools: MakeClothes ]]: Description of the MakeClothes™ tool, to create custom clothes for MakeHuman.
+
|}
+
  
== Documentation for developers ==
+
* [[Documentation:What is an asset?|What is an asset?]]
 +
* [[Documentation:Finding and downloading more assets|Finding and downloading more assets]]
 +
* [[Documentation:Getting and installing BlenderTools|Getting and installing BlenderTools]]
 +
* [[Documentation:Targets|Targets]]
 +
* [[Documentation:Clothes|Clothes]]
 +
* [[Documentation:Texture painting a skin in blender|Texture painting a skin in blender]]
  
[[Technical notes on MakeHuman]]
+
==MakeClothes:  In-depth tutorials  ==
  
== Tutorials ==
+
* [[Documentation:Making a simple dress|Making a simple dress]]
{| cellspacing="11" style="width:100%;"
+
* [[Documentation:Making diapers for a baby|Making diapers for a baby]]
|-style="vertical-align:top;"
+
* [[Documentation:Controlling the result with vertex groups|Controlling the result with vertex groups]]
| style="width:33%;background-color: #E6EEE6; padding:.5em;"|
+
* [[Documentation:Modeling a sword|Modeling a sword]]
* [[Documentation:Texture painting a skin in blender|Tutorial: Texture painting a skin in blender]]
+
|}
+
  
== Unported stuff from Drupal ==
+
==MakeClothes V2:  In-depth tutorials  ==
  
This is stuff which haven't been ported yet.
+
* [[Documentation:Features of new Blender plugin|Features of new Blender plugin]]
 +
 
 +
== MakeWalk: General Background ==
 +
 
 +
* [[Documentation:MakeWalk|MakeWalk]]
 +
 
 +
== MakeWalk: In Depth Tutorials ==
 +
 
 +
* [[Documentation:Running feet|Running feet]]
 +
* [[Documentation:Automatic animation|Automatic animation]]
 +
 
 +
== Interacting with the community ==
 +
 
 +
* [[Documentation:Asking for help|Asking for help]]
 +
* [[Documentation:Reporting a bug|Reporting a bug]]
 +
 
 +
== MakeHuman for developers ==
 +
 
 +
* [[Documentation: Plugin System|Plugin System]]
 +
* [[Documentation: OpenGL Notes|OpenGL Notes]]
 +
* [[Documentation: Directory structure and core modules|Directory structure and core modules]]
 +
* [[Documentation: File formats and extensions|File formats and extensions]]
 +
* [[Documentation: Libraries and build procedures|Libraries and build procedures]]
 +
* [[Documentation: Development infrastructure|Development infrastructure]]
 +
* [[Documentation: Application design and Code overview|Application design and Code overview]]
 +
* [[Documentation: Getting started with MakeHuman code|Getting started with MakeHuman code]]
 +
* [[Technical notes on MakeHuman]]
 +
 
 +
== Other / unsorted ==
 +
 
 +
* [[Documentation:Translation|Translation]]
 +
* [[Documentation:Installing MHX2|Installing MHX2]]
 +
 
 +
== Meta ==
 +
 
 +
* [[Documentation:Planning on how to restructure the documentation]]
 +
 
 +
== Old documentation ==
 +
 
 +
The old documentation is available, but in a largely unformatted state:
  
 
[[Documentation:Big dump from drupal]]
 
[[Documentation:Big dump from drupal]]
  
==== General overview ====
+
(most of this should now have been ported to separate pages as per above)
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:Install MakeHuman™|Install MakeHuman™  ]]: <br />How to install MH on Windows, Osx and Linux.
+
* [[ Documentation:The Interface and basic functions.|The Interface and basic functions. ]]: <br />The MakeHuman GUI: Load, save, undo and redo, reset, view, symmetry, help.
+
* [[ Documentation:Zoom, pan and rotate using the orbital camera|Zoom, pan and rotate using the orbital camera ]]: <br />Navigating the scene using the orbital camera.
+
* [[ Documentation:Load Save and Export|Load Save and Export  ]]: <br />Describe file actions for MakeHuman
+
|}
+
==== Define Human Characteristics ====
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:Parametric Modelling|Parametric Modelling  ]]: <br />A quick introduction to the parametric modelling and sliders usage.
+
* [[ Documentation:Using MakeHuman Hairstyles and Clothes|Using MakeHuman Hairstyles and Clothes  ]]: <br />Hair in the MakeHuman Geometries group
+
* [[ Documentation:Skin and other materials|Skin and other materials ]]: <br />How to change skin and materials for hair and clothes.
+
* [[ Documentation:Gender, Random, Measure and Custom|Gender, Random, Measure and Custom ]]: <br />Special modifiers.
+
* [[ Documentation:Makehuman alternative topologies|Makehuman alternative topologies ]]: <br />MakeHuman provides a smart alternative topologies library
+
|}
+
==== Rendering Your Work ====
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:Quick rendering and advanced rendering|Quick rendering and advanced rendering ]]: <br />This section explains how render the character in MakeHuman
+
* [[ Documentation:Scene and Viewer|Scene and Viewer ]]: <br />How to set lights and how to see and save the rendering
+
|}
+
==== Settings ====
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:General|General ]]: <br />How to set the general preferences
+
* [[ Documentation:Background|Background ]]: <br />How to use backgrounds for reference.
+
* [[ Documentation:Mouse|Mouse ]]: <br />Explanation of mouse settings
+
* [[ Documentation:Shortcuts|Shortcuts ]]: <br />Configuration of shortcuts in Makehuman
+
* [[ Documentation:Plugins|Plugins ]]: <br />Management of Makehuman plugins
+
|}
+
==== Tools and contributing methods ====
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:MHBlenderTools:MakeWalk|MHBlenderTools: MakeWalk ]]:<br />MakeWalk™ is a Blender add-on for retargeting mocap data (.bvh files) to a given armature.
+
** [[ Documentation:MHBlenderTools:MakeWalk GUI|MHBlenderTools: MakeWalk GUI ]]:<br />An introduction to MakeWalk™ and its user interface.
+
** [[ Documentation:MHBlenderTools:MakeWalk Armatures|MHBlenderTools: MakeWalk Armatures ]]:<br />An introduction to MakeWalk™ and the use of armatures. Explaining the meaning and use of source and target armature.
+
** [[ Documentation:MHBlenderTools:MakeWalk Utilities|MHBlenderTools: MakeWalk Utilities ]]:<br />An introduction to the MakeWalk™ utilities panel: save and restore the defaults, manage actions, t-pose, etc.
+
** [[ Documentation:MHBlenderTools:MakeWalk Retarget|MHBlenderTools: MakeWalk Retarget ]]:<br />An introduction to MakeWalk™ target rigging. This document will describe common errors and corrective actions.
+
* [[ Documentation:MHBlenderTools:MHX importer basic usage.|MHBlenderTools: MHX importer basic usage. ]]:<br />MHX (MakeHuman eXchange format) is a custom format used to transfer a rigged character from MakeHuman to Blender.
+
* [[ Documentation:MHBlenderTools:MHX default rigging|MHBlenderTools: MHX default rigging ]]:<br />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.
+
* [[ Documentation:MHBlenderTools:MHX other rigging systems|MHBlenderTools: MHX other rigging systems ]]:<br />The character can be rigged with alternatives and ligher armature or the rigify one (The rigging system for Blender developed by Nathan Vegdahl).
+
* [[ Documentation:MHBlenderTools:MHX Layers and masks|MHBlenderTools: MHX Layers and masks ]]:<br />The mhx importer creates objects on the first four layers.
+
* [[ Documentation:MakeTarget standalone|MakeTarget standalone ]]:<br />Converting files produced with the most common modelling software, without Blender.
+
* [[ Documentation:GUI languages and translations.|GUI languages and translations. ]]:<br />MakeHuman support a variety of languages. It's very easy to add translations.
+
|}
+
==== Reporting a Bug ====
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:Using the Makehuman bug tracker|Using the Makehuman bug tracker ]]: <br />Introduction to the new Makehuman bug tracker
+
* [[ Documentation:Using the Makehuman log files for error reporting|Using the Makehuman log files for error reporting ]]: <br />How to report bugs using the log files.
+
|}
+
==== Developers' note ====
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:Getting started|Getting started ]]: <br />The best way to start your experiments with MakeHuman code is to clone our official repository and start to modify it.
+
* [[ Documentation:Development infrastructure|Development infrastructure ]]: <br />A description of the MakeHuman development infrastructure.
+
* [[ Documentation:OpenGL Notes|OpenGL Notes ]]: <br />Most of the 3D mesh handling functionality is delivered using OpenGL embedded within the C application code.
+
* [[ Documentation:Development organization|Development organization ]]: <br />The organization of distributed development.
+
* [[ Documentation:Libraries and build procedures|Libraries and build procedures ]]: <br />Describes the details of creating installable packages on major platforms
+
* [[ Documentation:Directory structure and core modules|Directory structure and core modules ]]: <br />Summary of the MH API reference.
+
* [[ Documentation:File formats and extensions|File formats and extensions ]]: <br />Describes the formats used internally for data and object storage. [CRUDE NOTES]
+
* [[ Documentation:Makehuman Plugin System|Makehuman Plugin System ]]: <br />How to make a new plugin and use it in MakeHuman
+
|}
+
==== Packager's notes ====
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:Packaging RPM's for Suse/Fedora using Open Build Service (OBS)|Packaging RPM's for Suse/Fedora using Open Build Service (OBS) ]]: <br />Packaging procedure and setup.
+
|}
+
=== Tutorials ===
+
{| cellspacing="11" style="width:100%;"
+
|-style="vertical-align:top;"
+
| style="width:33%;background-color: #EEE6E6; padding:.5em;"|
+
* [[ Documentation:MakeClothes:Making a simple dress|MakeClothes: Making a simple dress ]]: <br />The basic MakeClothes workflow.
+
* [[ Documentation:MakeClothes:Controlling the result with vertex groups|MakeClothes: Controlling the result with vertex groups ]]: <br />The output of the clothes-making process depends on how vertex groups are assigned.
+
* [[ Documentation:MakeTarget:Creating a Custom Target with MakeTarget Standalone|Creating a Custom Target with MakeTarget Standalone ]]: <br />A practical example of custom target
+
* [[ Documentation:MakeWalk:The making of Running feet|MakeWalk: The making of Running feet ]]: <br />MakeWalk tutorial, focusing on the Edit Action panel.
+
* [[ Documentation:MakeWalk:Running feet scene 1|MakeWalk: Running feet scene 1 ]]: <br />Making an extended run on a plane.
+
* [[ Documentation:MakeWalk:Running feet scene 2|MakeWalk: Running feet scene 2 ]]: <br />High heels and slopes.
+
* [[ Documentation:MakeWalk:Running feet scene 3|MakeWalk: Running feet scene 3 ]]: <br />The race.
+
* [[ Documentation:MakeWalk:Running feet scene 4|MakeWalk: Running feet scene 4  ]]: <br />Rough terrain.
+
* [[ Documentation:MakeWalk:Automatic animation |MakeWalk: Automatic animation ]]: <br />Tutorial on using the editing tools in MakeWalk.
+
|}
+
__NOTOC__
+
  
<!--
+
The following have been merged in other pages, but they are left here if something got lost in the translation:
Author Notes:
+
== 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]])
+
* [[ Documentation:MHBlenderTools: Download and installation|MHBlenderTools: Download and installation ]]: How to download and install the addons for Blender
-->
+
* [[ Documentation:MHBlenderTools: MakeTarget|MHBlenderTools: MakeTarget ]]: Description of the MakeTarget™ tool, to create custom morphings for MakeHuman.
 +
* [[ Documentation:MHBlenderTools:MakeClothes|MHBlenderTools: MakeClothes ]]: Description of the MakeClothes™ tool, to create custom clothes for MakeHuman.

Revision as of 13:41, 21 June 2020

Introduction

General overview

Working with the human

Exporting your work to another application

Working with MakeHuman models in Blender

Downloading or creating new assets

MakeClothes: In-depth tutorials

MakeClothes V2: In-depth tutorials

MakeWalk: General Background

MakeWalk: In Depth Tutorials

Interacting with the community

MakeHuman for developers

Other / unsorted

Meta

Old documentation

The old documentation is available, but in a largely unformatted state:

Documentation:Big dump from drupal

(most of this should now have been ported to separate pages as per above)

The following have been merged in other pages, but they are left here if something got lost in the translation: