User Interface explanation - Zariep-Software/WiPersona GitHub Wiki

User Interface explanation

This page will explain how to interact with the user interface

WiPersona UI is a quite simple, everytime you open the program, you will see a main menu similar to this:

   +-----------------------------------------------------------------------------------------------------------+
   | Avatar Settings                                                         |                                 |
   |                                                                         |                                 |
   |  Due to security reason, WiPersona can't save information about selected|                                 |
   |  files, if you are running WiPersona locally, put your pictures in "res"|                                 |
   |  folder, sorry for the inconvenience.                                   |                                 |
   |                                                                         |                                 |
   | Avatar (Mute): [select file]                                            |                                 |
   | Avatar (Talking): [select file]                                         |          WiPersona              |
   | Avatar (Screaming): [select file]                                       |                                 |
   | Avatar at center: [ ]                                                   |  v1.2                           |
   | X Position:  10                                                         |                                 |
   | Y Position:  10                                                         |  Created by ItzSelenux          |
   | Avatar Size (px):  512                                                  |                                 |
   |                                                                         |  Zariep software 2024           |
   | Background Settings                                                     |                                 |
   |                                                                         |  Source code                    |
   |  Show background: [ ]                                                   |                                 |
   |  Select background: [select file]                                       |  Online manual                  |
   |  In-talk effect: [none]                                                 |                                 |
   |  Effect on Talk to Scream: [ ]                                          |                                 |
   |                                                                         |                                 |
   | Voice Settings                                                          | [Save config][Restore defaults] |
   |                                                                         | [Show link to this config]      |
   |      Give mic access to completely start the program                    |                                 |
   |                                                                         |                                 |
   | Request mic access                                                      |                                 |
   |                                                                         |                                 |
   | Voice Status: Silence                                                   |                                 |
   | Speech Threshold: 15 15 <---------------->                              |                                 |
   | Scream Threshold: 30 30 <----------------->                             |                                 |
   +-----------------------------------------------------------------------------------------------------------+]

  • To hide the menu, you need to click outside the menu, to see the menu, click on any part of the page
  • The menu will be scrollable if you screen is small

Options:

Value Category Type Details
Avatar (Mute) Avatar File Select image to replace muted avatar
Avatar (Talking) Avatar File Select image to replce speaking avatar
Avatar (Screaming) Avatar File Select image to replace screaming avatar
Avatar at center Avatar Checkbox Toggle centered avatar
X Position Avatar Number Select avatar X Position if is not centered
Y Position Avatar Number Select avatar Y Position if is not centered
Avatar Size (px) Avatar Number Select avatar size
In-talk effect Avatar Select Select/disable avatar in-talk animation
Brightness effect Avatar Select Select/disable avatar brightness behavior
Effect on Talk to Scream Avatar Checkbox Toggle on scream animation
Background Color Background Color Change background color
Show background Background Checkbox Toggle background
Select background Background Checkbox Select background if background is enabled
Request mic access Voice Button Request Microphone access to web browser
Voice Status Voice Text Show voice internal status to determine avatar image to use
Speech Threshold Voice Range Select minimum threshold to show speaking avatar
Scream Threshold Voice Range Select minimum threshold to show screaming avatar
Save config Settings Button Save config using browser cookies
Restore defaults Settings Button Restore config to default values (overwriting cookies) and reload the page
Show link to this config Settings Button Show a link to a shareable config based on the selected on the session
WiPersona Info Text Title, informational
Created by ItzSelenux Info Link link to ItzSelenux's Github profile
Zariep software 2024 Info Link link to Zariep Software Organization Github profile
Source code Info Link link to WiPersona source code