Added installation instructions

This commit is contained in:
Cowwan 2024-02-05 21:11:59 -05:00
parent c0b8a8fc8c
commit 1b1ef203f0
2 changed files with 24 additions and 53 deletions

24
README.txt Normal file
View file

@ -0,0 +1,24 @@
-----How to Install-----
This is for linux, idk how python packages work in windows
*Download the project, there's not really a "release" because it's a bunch of .py files, there's nothing to compile or build
*Open a terminal in the project folder
*Create a virtual environment using 'python3 -m venv .venv'
*Activate the virtual environment with 'source .venv/bin/activate'
*Using pip, install the following packages:
numpy
onnxruntime
opencv-python
On the Vtube Studio side:
*go to .../VTube Studio/VTube Studio_Data/StreamingAssets/
*create a file named 'ip.txt'
*put the following in ip.txt:
# To listen for remote connections, change this to 0.0.0.0 or your actual IP on the desired interface.
ip=127.0.0.1
# This is the port the server will listen for tracking packets on.
port=11573
And you're done, it's installed
you can run it by running my facetracking.sh shell script which applies some settings I found useful for my camera (though I'm unsure how compatible they are with other setups), or you can just use 'python3 facetracker.py' after re-activating the virtual environment

View file

@ -1,53 +0,0 @@
# -*- mode: python ; coding: utf-8 -*-
block_cipher = None
a = Analysis(['facetracker.py'],
pathex=['C:\\OpenSeeFaceBuild'],
binaries=[('dshowcapture/dshowcapture_x86.dll', '.'), ('dshowcapture/dshowcapture_x64.dll', '.'), ('dshowcapture/libminibmcapture32.dll', '.'), ('dshowcapture/libminibmcapture64.dll', '.'), ('escapi/escapi_x86.dll', '.'), ('escapi/escapi_x64.dll', '.'), ('run.bat', '.'), ('msvcp140.dll', '.'), ('vcomp140.dll', '.'), ('concrt140.dll', '.'), ('vccorlib140.dll', '.')],
datas=[],
hiddenimports=[],
hookspath=[],
runtime_hooks=[],
excludes=['matplotlib', 'mpl-data', 'PyInstaller', 'pywt', 'skimage', 'scipy', 'pyinstaller'],
win_no_prefer_redirects=False,
win_private_assemblies=False,
cipher=block_cipher,
noarchive=False)
remove_bin = []
for bin in a.binaries:
if bin[0].startswith("opencv_video") or bin[0].startswith("PyInstaller"):
remove_bin.append(bin[0])
print(bin)
remove_dat = []
for bin in a.datas:
if bin[0].startswith("opencv_video") or bin[0].startswith("PyInstaller"):
remove_dat.append(bin[0])
print("data ", bin)
a.binaries = [x for x in a.binaries if not x[0] in remove_bin]
a.datas = [x for x in a.datas if not x[0] in remove_dat]
pyz = PYZ(a.pure, a.zipped_data,
cipher=block_cipher)
exe = EXE(pyz,
a.scripts,
[],
exclude_binaries=True,
name='facetracker',
debug=False,
bootloader_ignore_signals=False,
strip=False,
upx=True,
console=True )
coll = COLLECT(exe,
a.binaries,
a.zipfiles,
a.datas,
strip=False,
upx=True,
upx_exclude=[],
name='facetracker')