Stream-Mask

PNGTuber animation utility

• create an animated 2D avatar using png, jpg, or jpeg files
• great for live and recorded scenarios

Supported Platforms

• windows
• linux

Config File Information

• volume_level: minimum volume needed to detect voice
  • lower value = more sensitive
• magnitude_level: minimum magnitude needed to detect voice
  • lower value = more sensitive
• animation speed: how fast animation moves from silent to talking frame
  • recommend leaving at 1 (higher value = faster animation)
• frame_duration: how long frame stays active
  • recommend leaving at 1 (higher value = longer duration)
• talk_frame_name: name/path of file for displaying animation while talking
• silent_frame_name: name/path of file for displaying animation for silence

Install Instructions

• Note: this program uses the microphone the operating system has set to default

1. download and extract zip file to desired location
2. add png files to same directory as extracted files
3. make sure image names match what the config file says
4. open executable and use utility
   • windows: click executable to run
   • linux:
     • chmod +x [filename]
     • ./[filename]

Build Instructions

• Note: it is recommended to use Godot version 4.4.1

1. clone or download/extract repository to desired location
2. open Godot and create new project using cloned/downloaded repository
3. go to top right corner and click Project -> Export...
4. go through export steps based on platform needing the build

License

• this software is distrubuted under the MIT License

Made with Godot Engine and GDScript