Written by StrongmanLin

Some useful tips

• Real-time CaveGen is ONLY AVAILABLE FOR WINDOWS. If you are on Mac, you can still do all of these steps except for installing OBS virtual cam, so you can still analyze old runs, but you cannot use it with live runs.
• You can open a command terminal on Windows by searching for "Command Prompt" in the Windows search bar and clicking on the result, or on Mac by pressing the Command (⌘) button and space bar at the same time, then searching for "Terminal" and hitting enter.
• Running a command means typing that command into a terminal and pressing enter. I will denote the command by surrounding it with single quotes e.g. 'git status'.
• If you are on Linux, the Mac commands should all work for you, but again, no virtual cam.
• I list some ways to verify your installs. With the exception of verifying git, these are optional and require you to do things, like add to your PATH environment variable, that are optional for CaveGen to work, so if you don't want to do any extra work, install everything without verifying first, and only start verifying if something gives you an error.

#Step 1: Install git

• visit https://git-scm.com/downloads
• click on the download for your operating system
• double-click the file that is downloaded and follow its prompts
• verify your install by opening a new command terminal and running 'git --version' and seeing one or two lines printed out displaying the git version
• if you get an error about git not being recognized, it may not be in your PATH environment variable.
  • This can be verified by running 'echo %PATH% | findstr Git' on Windows or 'echo $PATH | grep git' on Mac and getting a blank line as output
  • Add git to your path by running 'set PATH="%PATH%C:\Program Files\Git\cmd;"' on Windows or 'export PATH=/usr/local/git/bin:$PATH' on Mac then close and reopen your terminal and try running 'git --version' again

#Step 2: Install Python3.6+

• visit https://www.python.org/downloads/ and download the installer for your operating system
• double click the file that is downloaded and follow its prompts. If you see a box to Add Python to PATH during installation, check that box
• verify your install by opening a new command terminal and running 'python --version' and getting a line or two of output about your version
• if you get an error about python not being recognized, try running 'python3 --version' instead. If it's still not recognized, try the next step.
• if python is still not being recognized, it may not be in your PATH environment variable
  • This can be verified by running 'echo %PATH% | findstr Python' on Windows or 'echo $PATH | grep Python' on Mac and getting a blank line as output
  • Find your python installation directory. On Windows this should be \Users<username>\AppData\Local\Programs\Python<pythonVersionDirectory>, and on Mac this should be either /usr/bin/python3 or /usr/local/bin/python3. Add python to your path by running 'set PATH="%PATH%<your python installationg directory here>;' on Windows or 'export PATH=<your python installationg directory here>:$PATH' on Mac. MAKE SURE TO REPLACE THE <> IN THE COMMAND WITH YOUR INSTALLATION DIRECTORY. You can then close and reopen your command terminal and try running 'python --version' again.

#Step 3: Install numpy and cv2

• pip is a tool that comes installed with python, so if you installed python correctly, you should be able to run 'pip --version' and get some output about your pip version
• install numpy by running 'pip install numpy'
• install cv2 by running 'pip install opencv-python'
• verify your numpy installation by running 'pip install numpy' again and having it tell you it's already installed
• verify your cv2 installation by running 'python -c "import cv2"' and getting a blank line as output

#Step 4: Install java

• visit https://www.java.com/en/download/ and download the installer with the big red "Agree and Start Free Download" button
• Double click the installer and follow the prompts
• verify your install by looking for a Java directory in "C:\Program Files\Java" on Windows or by running '/usr/libexec/java_home' in a new Mac terminal

#Step 5: Install OBS

• visit https://obsproject.com/download and download then double click the installer for your operating system
• if you run into problems, watch for Windows or for Mac

#Step 6: Install virtual cam plugin for OBS

• visit https://obsproject.com/forum/resources/obs-virtualcam.949/ and click on the "Go to download" button on the right to download the installer then run it
• make sure to install virtual cam to the same directory as your OBS install
• just select 1 when it asks how many cameras you want
• verify your install by opening OBS, clicking the "Tools" menu at the top, and seeing a "VirtualCam" option
• if this is not there, try uninstalling both the virtual cam and obs by double clicking the uninstall executable files located in your OBS installation directory, then reinstalling both. This will not delete any of your existing layouts or settings if you're worried about that.
• if you would like a video tutorial, try this

#Step 7: Use JHawk's tutorial video

• visit this page https://github.com/JHaack4/CaveGen/ and scroll down to step 7)
• use this video for the rest of the cavegen setup