Skip to content

Commit

Permalink
clarifying the readme text and adding an extra image
Browse files Browse the repository at this point in the history
  • Loading branch information
nathan-meshcapade committed Apr 16, 2024
1 parent 8fa1591 commit 78f039e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Meshcapade Plugin for Unreal Editor for Fortnite (UEFN)

<!--
remove this once the page is actually live
<p class='hidden'>For a better viewing experience, visit our <a href='https://me.meshcapade.com/integrations/uefn'>webpage</a>.</p>
-->

This plugin allows you to quickly retarget motions created on the [Meshcapade.me](https://me.meshcapade.com/) platform onto your own characters in [Unreal Editor for Fortnite](https://store.epicgames.com/en-US/p/fortnite--uefn). Bodies created on the Meshcapade platform are created using the [SMPL](https://smpl.is.tue.mpg.de/) core technology, and are thus referred to as [SMPL-bodies](https://smpl.is.tue.mpg.de/license.html).

This plugin was developed in Fortnite 29.20 (Unreal Engine: 5.4.0). Unreal Engine for Fortnite is currently in Beta.

<details open>
<summary>I. Adding the plugin to your UEFN project</summary>

Expand Down Expand Up @@ -36,7 +41,7 @@ To search for a motion from our motion library, visit the Meshcapade [editor](ht
<details id='downloading'>
<summary>III. Downloading the animation </summary>

Go to your [avatar vault](https://me.meshcapade.com/vault), and click the `...` on the top right corner of the avatar containing the motion you'd like to download. In the download options, make sure that `file format` is `.FBX` (`.OBJ` has no motion) and that `Pose/Motion` is `Captured Motion`. For `compatibility mode`, select `Unreal - no blend shapes` if you're only interested in the motion which will make the import process faster. Choose `Unreal` if you want to use [Pose Correctives](#pose-correctives).
Go to your [avatar vault](https://me.meshcapade.com/vault), and click the `...` on the top right corner of the avatar containing the motion you'd like to download, and click `download`. In the download options, make sure that `file format` is `.FBX` (`.OBJ` has no motion) and that `Pose/Motion` is `Captured Motion`. For `compatibility mode`, select `Unreal - no blend shapes`.

![download](images/readme_download00.png)

Expand All @@ -58,29 +63,27 @@ Set the skeleton to `SK_MeshcapadeBody`.
<details>
<summary>V. Retargeting the animation</summary>

One thing you may want to do is retarget the motion from the SMPL-body onto the body of your character. To do so, you will need a retargeter. Retargeters require two IK rigs: one for the source body, the SMPL-body in this case, and one for the target body - your character. The Meshcapade UEFN plugin comes with a sample retargeter for the Fortnite mannequin, including an IK rig for the SMPL-body and an IK rig for the Fortnite mannequin.
In UEFN, the process of transferring an animation from one character to another is called retargeting. This plugin comes with a SMPL-body to Fortnite retargeter.

### A. Creating a Retargeter
### A. Using the Retargeter

To retarget an animaiton from a SMPL-body onto a Fortnite character, the first step is to right click on it and choose `Retarget Animations`
To retarget an animaiton from a SMPL-body onto a Fortnite character, right click on an animation and choose `Retarget Animations`

![retargeting00](images/readme_retargeting00.png)

Uncheck `Auto Generate Retargeter`

Change the Retarget Asset to `RTG_Meshcapade_to_FN`

Double click the animation you'd like to retarget (`AS_Soccer` in this example)

Then select `Export Animations`
To use our retargeter:
- Uncheck `Auto Generate Retargeter`
- Change the Retarget Asset to `RTG_Meshcapade_to_FN`
- Double click the animation you'd like to retarget (`AS_Soccer` in this example)
- Then select `Export Animations`

![retargeting01](images/readme_retargeting01.png)

For more information on this subject, see the Unreal documentation on [IK Rig Animation Retargeting](https://docs.unrealengine.com/5.3/en-US/ik-rig-animation-retargeting-in-unreal-engine/).

Choose where you would like to export it, and then click export.

You can now use this animation with any Fortnite character. Below is an example of the soccer animation retargeted onto several Fortnite characters.
You can now use this animation with any Fortnite character. For example, the video below has the retargeted soccer animation assigned to the `Custom Idle` variable on several Fortnite `Character Device` objects.

![retargeting02](images/readme_retargeting02.png)

[![Retargeting Example](images/readme_preview_retargetingexample.png)](https://youtu.be/HimMaKC5-ew "Retarget Example")

Expand Down
Binary file added images/readme_retargeting02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 78f039e

Please sign in to comment.