Skip to content

Commit

Permalink
Update documentation links and small corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
NumesSanguis committed Jan 13, 2019
1 parent 92348ea commit 4c24fa0
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 105 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ More [detailed quickstart](https://facsvatar.readthedocs.io/en/latest/quickstart
Use the numbers 0, 1, 2 on your keyboard to change camera.

## Quickstart video (NEW)
See the quickstart video: SOON
See the quickstart video:

[![FACSvatar Quickstart 2019-01 (v0.3.4)](https://img.youtube.com/vi/OOoXDfkn8fk/0.jpg)](https://www.youtube.com/watch?v=OOoXDfkn8fk)

## Full documentation
[Read the FACSvatar documentation](https://facsvatar.readthedocs.io/en/latest/)!
Expand Down
5 changes: 3 additions & 2 deletions blender/facsvatar_zeromq.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# script = "/*path*/blender/facsvatar_zeromq.py"
# script = "/*path*/blender/facsvatar_zeromq.py" # change / to \\ in Windows
# exec(compile(open(script).read(), script, 'exec'))
import bpy
import os
import sys
import asyncio
sys.path.append('/home/stef-ubuntu/anaconda3/envs/blender/lib/python3.5/site-packages')
sys.path.append('/home/*you*/anaconda3/envs/blender/lib/python3.5/site-packages')
#Windows: sys.path.append('c:\\Users\\*you*\\AppData\\Local\\conda\\conda\\envs\\blender\\Lib\\site-packages')
import zmq
#from zmq.asyncio import Context
import json
Expand Down
15 changes: 11 additions & 4 deletions docs/source/defaultsetup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ If you're already done setting FACSvatar up, please head here: :doc:`firstrun`

| but before that, let's download the FACSvatar GitHub repro with:
| ``git clone https://github.com/NumesSanguis/FACSvatar.git``
| and download all other necessary files from the release page:
| https://github.com/NumesSanguis/FACSvatar/releases
------------------------
FACS input
Expand All @@ -39,15 +41,15 @@ For the real-time version of FACSvatar we need to use a modified OpenFace which
to stream AU, gaze and head pose data out of it into.
You can either

* Download a `modified OpenFace v2.0.6 <https://numessanguis.stackstorage.com/s/qHqzGSi5zxC73rk/>`_
* Download a `modified OpenFace v2.1.0 <https://github.com/NumesSanguis/FACSvatar/releases/download/v0.3.4-alpha-release/openface_2.1.0_zeromq.zip>`_
* All copyright of OpenFace belongs to Carnegie Mellon University. By using this software, you agree to their licensing terms found here: https://github.com/TadasBaltrusaitis/OpenFace/
* Or build the modified version yourself following these instructions:

""""""""""""""""""""""""""
Build OpenFace with ZeroMQ
""""""""""""""""""""""""""

- Download Source code OpenFace 2.0.6 from https://github.com/TadasBaltrusaitis/OpenFace/releases
- Download Source code OpenFace 2.1.0 from https://github.com/TadasBaltrusaitis/OpenFace/releases
- Install Visial Studio 2015 / 2017
- Run download_models.ps1 / .sh
or copy ``cen_patches_x.xx_of.dat`` to ``OpenFace\lib\local\LandmarkDetector\model\patch_experts``
Expand Down Expand Up @@ -139,7 +141,9 @@ Recommended for real-time or game like interaction applications. Unity3D version

2. Open the FACSvatar project in Unity3D by navigation to ``FACSvatar/unity_FACSvatar`` folder
in the FACSvatar GitHub repro.
3. In the ``Asset Store`` tab: Search for JSON .NET for Unity (by PARENTELEMENT, LLC) and click ``Download``.
3. (In the ``Asset Store`` tab: Search for JSON .NET for Unity (by PARENTELEMENT, LLC) and click ``Download``.)

* This step is probably not needed anymore.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Blender - open source 3D creation suite
Expand All @@ -149,7 +153,7 @@ Blender - open source 3D creation suite
| Hopefully going to be real-time and as a Blender add-on when version 2.8 with EEVEE is released.
1. `Download Blender <https://www.blender.org/>`_
#. `Download Manuel Bastioni LAB (MBLAB) add-on v.1.6.1a for Blender <https://numessanguis.stackstorage.com/s/jLamuetD8drgCfP>`_
#. `Download Manuel Bastioni LAB (MBLAB) add-on v.1.6.1a for Blender <https://github.com/NumesSanguis/FACSvatar/releases/download/v0.3.4-alpha-release/manuelbastionilab_161a.zip>`_

* The author of MBLAB unfortunately stopped with his project (http://www.manuelbastioni.com/)
* However, the community is still active: https://github.com/animate1978/MB-Lab
Expand All @@ -169,6 +173,9 @@ Blender - open source 3D creation suite

#. Change line 7 in ``FACSvatar/blender/facsvatar_zeromq.py`` to correctly point to your blender anaconda environment.

* Windows (something like): c:\\Users\\*you*\\AppData\\Local\\conda\\conda\\envs\\blender\\Lib\\site-packages
* Ubuntu (something like): /home/*you*/anaconda3/envs/blender/lib/python3.5/site-packages

"""""""""""""""""""""""""""""""""""""
Enabling FACS sliders in MBLAB add-on
"""""""""""""""""""""""""""""""""""""
Expand Down
9 changes: 6 additions & 3 deletions docs/source/firstrun.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@ Visualization: Unity3D - real-time
------------------------------------------------
Visualization: Blender - offline
------------------------------------------------
Sorry, these instructions are still a mess.
Sorry, these instructions are still a mess. Look at the Blender tutorial video for clearer instructions.

0. Do these steps before running other FACSvatar modules.
1. Copy the first 2 lines of code found in ``FACSvatar/blender/facsvatar_zeromq.py`` into the Blender terminal (but change path to match your system's path to that file).

* Windows: Change ``/`` to ``\\``

2. Your Blender now freezes and waits for data from Blend Shapes module. (You can safely send 1x a cancel command in terminal that runs Blender to cancel listening for data).
3. Yes, I know, the freezing part is bad. This, and all these instructions, should be gone once the Blender component of FACSvatar is turned into a Blender add-on.
4. Data is streamed into the timeline of Blender and can be modified following the normal workflow of Blender.
Expand All @@ -35,8 +38,8 @@ Open 3 terminals
1. Start bridge module

1. ``source activate facsvatar``
2. ``cd *your_path*/FACSvatar/modules``
3. ``python n_bridge_m.py``
2. ``cd *your_path*/FACSvatar/modules/process_bridge``
3. ``python main.py``

#. Start FACS to Blend Shapes module

Expand Down
95 changes: 0 additions & 95 deletions unity_FACSvatar/Assets/Objects/mouthCover.obj.meta

This file was deleted.

0 comments on commit 4c24fa0

Please sign in to comment.