252 lines
16 KiB
HTML
252 lines
16 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>MetaHuman DNA Calibration — DNA Calibration documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Repository Organization" href="repository_organization_md.html" />
|
||
<link rel="prev" title="MetaHuman DNA Calibration" href="index.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
<a href="index.html" class="icon icon-home"> DNA Calibration
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">MetaHuman DNA Calibration</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="#overview">Overview</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#required-knowledge">Required Knowledge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#optional-knowledge">Optional Knowledge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#dnacalib">DNACalib</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#external-software-dependencies">External Software Dependencies</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#dnaviewer">DNAViewer</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="#examples">Examples</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#example-dna-files">Example DNA files</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="#notes">Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="#license">License</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Repository Organization</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="repository_organization_md.html">Repository Organization</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="repository_organization_md.html#folder-structure">Folder structure</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">DNACalib</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="dnacalib_md.html">DNACalib</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">DNAViewer</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_md.html">DNAViewer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_maya_md.html">Usage in Maya</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">DNAViewer API</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_api_md.html">Environment Setup</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="dna_viewer_api_md.html#dna">DNA</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Technical documentation</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="dnacalib.html">dnacalib</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="modules.html">dna_viewer</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">FAQ</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="faq_md.html">Frequently Asked Questions (FAQ)</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">DNA Calibration</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||
<li>MetaHuman DNA Calibration</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/index_.md.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="metahuman-dna-calibration">
|
||
<h1>MetaHuman DNA Calibration<a class="headerlink" href="#metahuman-dna-calibration" title="Permalink to this headline"></a></h1>
|
||
<p>MetaHuman DNA Calibration is a set of tools used for working with MetaHuman DNA files, bundled into a single package.
|
||
DNA is an integral part of <a class="reference external" href="https://www.unrealengine.com/en-US/metahuman">MetaHuman</a> identity.
|
||
DNA files are created with <a class="reference external" href="https://metahuman.unrealengine.com/">MetaHuman Creator</a> and downloaded with
|
||
<a class="reference external" href="https://docs.metahuman.unrealengine.com/en-US/downloading-metahumans-with-quixel-bridge/">Quixel Bridge</a>.</p>
|
||
<p>MetaHuman DNA Calibration is a set of tools used for working with MetaHuman DNA files, bundled into a single package. We wanted to share this code to help users customize DNA files so they can better integrate the characters they create into their games and experiences.
|
||
MetaHuman DNA Calibration tools are provided in a GitHub repository located at this address.</p>
|
||
</section>
|
||
<section id="overview">
|
||
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h1>
|
||
<p>For an explanation about how the repository is organized, <a class="reference internal" href="repository_organization_md.html"><span class="doc std std-doc">click here</span></a>.</p>
|
||
<p>The MetaHuman DNA Calibration repository contains two distinct tools:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="dnacalib_md.html"><span class="doc std std-doc">DNACalib</span></a> (and its dependencies)</p></li>
|
||
<li><p><a class="reference internal" href="dna_viewer_md.html"><span class="doc std std-doc">DNAViewer</span></a></p></li>
|
||
</ul>
|
||
<section id="required-knowledge">
|
||
<h2>Required Knowledge<a class="headerlink" href="#required-knowledge" title="Permalink to this headline"></a></h2>
|
||
<p>To use these tools, you should be familiar with:</p>
|
||
<ul class="simple">
|
||
<li><p>Rigging in Maya</p></li>
|
||
<li><p>Python</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="optional-knowledge">
|
||
<h2>Optional Knowledge<a class="headerlink" href="#optional-knowledge" title="Permalink to this headline"></a></h2>
|
||
<ul class="simple">
|
||
<li><p>C++ (for <a class="reference internal" href="dnacalib_md.html"><span class="doc std std-doc">DNACalib</span></a> and its <a class="reference internal" href="dnacalib_api_md.html"><span class="doc std std-doc">API</span></a>)</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="dnacalib">
|
||
<h2>DNACalib<a class="headerlink" href="#dnacalib" title="Permalink to this headline"></a></h2>
|
||
<p><a class="reference internal" href="dnacalib_md.html"><span class="doc std std-doc">DNACalib</span></a> and its <a class="reference internal" href="dnacalib_api_md.html"><span class="doc std std-doc">API</span></a> are used to inspect and modify DNA files. With <a class="reference internal" href="dnacalib_md.html"><span class="doc std std-doc">DNACalib</span></a>, you can make the following changes in DNA files:</p>
|
||
<ul class="simple">
|
||
<li><p>Rename joints, meshes, blendshapes, and / or animated maps.</p></li>
|
||
<li><p>Remove joints, meshes, and / or joint animation.</p></li>
|
||
<li><p>Rotate, scale, and translate the rig.</p></li>
|
||
<li><p>Remove LODs.</p></li>
|
||
<li><p>Change neutral joint positions, neutral mesh positions, and blendshape delta values.</p></li>
|
||
<li><p>Prune blendshapes.</p></li>
|
||
<li><p>Remove all blend shape data.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="external-software-dependencies">
|
||
<h2>External Software Dependencies<a class="headerlink" href="#external-software-dependencies" title="Permalink to this headline"></a></h2>
|
||
<p>DNACalib’s Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
|
||
If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
|
||
If a user has a different platform or architecture, the library and its dependencies must be compiled.</p>
|
||
<p><strong>Important</strong>
|
||
DNA files are stored as <a class="reference external" href="https://git-lfs.github.com/">LFS (Large File Storage)</a> files. They are downloaded with the rest of the code if
|
||
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.</p>
|
||
<p>Additional information can be found <span class="xref myst">here</span></p>
|
||
<p><strong>Warning:</strong>
|
||
Python 2 is not supported.</p>
|
||
<p>DNACalib can be used in C++ projects as a C++ library.</p>
|
||
<p>DNACalib Python wrapper can be used in Python 3.7, <code class="docutils literal notranslate"><span class="pre">mayapy</span></code> (Maya’s Python interpreter), or Maya 2022.</p>
|
||
</section>
|
||
<section id="dnaviewer">
|
||
<h2>DNAViewer<a class="headerlink" href="#dnaviewer" title="Permalink to this headline"></a></h2>
|
||
<p>With DNAViewer, you can:</p>
|
||
<ul class="simple">
|
||
<li><p>Create functional rigs for Maya.</p></li>
|
||
<li><p>Export FBX files.</p></li>
|
||
<li><p>Read internal parts of DNA files.</p></li>
|
||
</ul>
|
||
<p>DNAViewer can be used in <code class="docutils literal notranslate"><span class="pre">mayapy</span></code> (Maya’s Python interpreter) or in Maya 2022, except <a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_grab_changes_from_scene_and_propagate_to_dna.py">Propagating changes from Maya scene to dna</a> which can be used just in Maya.</p>
|
||
</section>
|
||
</section>
|
||
<section id="examples">
|
||
<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h1>
|
||
<p>Several Python examples are provided for reference and can be found in the <strong>examples’</strong> folder:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dnacalib_demo.py">Showcase a few commands</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dnacalib_rename_joint_demo.py">Rename a joint</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_demo.py">Create a small DNA from scratch</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dnacalib_lod_demo.py">Create a new DNA from an existing one by extracting specific LODs</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dnacalib_remove_joint.py">Remove a joint</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dnacalib_clear_blend_shapes.py">Clear blend shape data</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dnacalib_neutral_mesh_subtract.py">Subtract values from neutral mesh</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_run_in_maya.py">Simple UI in Maya</a> and some <span class="xref myst">documentation</span> for it</p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_demo.py">Generate rig and export FBX per LOD</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/examples/dna_viewer_grab_changes_from_scene_and_propagate_to_dna.py">Propagating changes from Maya scene to dna</a></p></li>
|
||
</ul>
|
||
<section id="example-dna-files">
|
||
<h2>Example DNA files<a class="headerlink" href="#example-dna-files" title="Permalink to this headline"></a></h2>
|
||
<p><a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/data/dna">Two demo DNA files</a> are provided for easier testing of this tool. Any DNA generated with <a class="reference external" href="https://www.unrealengine.com/en-US/metahuman">MetaHumanCreator</a>
|
||
should work.</p>
|
||
</section>
|
||
</section>
|
||
<section id="notes">
|
||
<h1>Notes<a class="headerlink" href="#notes" title="Permalink to this headline"></a></h1>
|
||
<p>If a user runs examples in Maya 2022, the value for <code class="docutils literal notranslate"><span class="pre">ROOT_DIR</span></code> should be changed and absolute paths must be used,
|
||
eg. <code class="docutils literal notranslate"><span class="pre">c:/dna_calibration</span></code> in Windows or <code class="docutils literal notranslate"><span class="pre">/home/user/dna_calibration</span></code> in Linux. Important: Use <code class="docutils literal notranslate"><span class="pre">/</span></code> (forward slash), Maya uses forward slashes in path.</p>
|
||
<p>See the <a class="reference internal" href="faq_md.html"><span class="doc std std-doc">FAQ guide</span></a> for additional specifications.</p>
|
||
</section>
|
||
<section id="license">
|
||
<h1>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h1>
|
||
<p>MetaHuman DNA Calibration is released with <a class="reference external" href="https://github.com/EpicGames/MetaHuman-DNA-Calibration/tree/main/LICENSE">licence</a>.</p>
|
||
</section>
|
||
<section id="indices-and-tables">
|
||
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
|
||
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
|
||
</ul>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="index.html" class="btn btn-neutral float-left" title="MetaHuman DNA Calibration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="repository_organization_md.html" class="btn btn-neutral float-right" title="Repository Organization" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2022, Epic Games.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |