Talking Sounds - Plugin 

こちらをクリックして  日本語のドキュメンテーション

Changelog

(FEB/05/2024) Release version!
(FEB/20/2024) Fixed issues with the last Bakin update 1.7.0.6
(FEB/22/2024) Now you can change the frequency at which the Talking Sound is played.

Description

The Talking Sounds plugin allows you to use sounds when messages are being displayed, and by adjusting the pitch, you can create a speech sound effect to add a fancy and professional touch to what your characters are saying!

• The plugin comes with  10 talking sounds!
• Change the sound and settings using C# call event panels or by using Bakin variables!
• You can use multiple sounds that will be randomized, change the volume, panning, and the pitch range in which it will randomly sound to create a speech-like sensation.
• GUI to customize variable names and add your sounds to a list as a cache for optimal performance in your game.

How to install

* Download and unzip the file, drag and drop "TalkingSounds" folder to the Bakin folder steamapps\common\BAKIN\plugins.

Note: To unzip, it is recommended to use WinRAR or another program. Using Windows to unzip it may damage the DLLs.

* Go to "Functions" -> "Expanded Features" and click on "Talking sounds".

* Use install button to automatically install the script into your project!

USE INSTALL BUTTON WHEN YOU NEED TO UPDATE THE SCRIPT FILE IN YOUR PROJECT TO A NEWER VERSION!

* Use Automation: "Common event" button to create a sample common event in your project 

or attach the script to a common event "TalkingSounds.cs", now you can use C# functions to setup the talking sounds, like this:

Please note that this event doesn't have an automatic trigger, so you should call this event manually if you want to use the configuration shown here.

How to use

IT IS RECOMMENDED TO USE MESSAGE TEXT SPEED IN NORMAL OR SLOW FOR BEST RESULTS! 

Save Button: Save your current configuration and your render presets and interiors.

Install Button: Install the script files into your project. If you updated the plugin, use this button to update the script in your project as well.

Help Button: It redirects you to this itch.io page.

Disable plugin: Deactivate the plugin completely.

Settings:

Bakin Variable Names: 

In this section, you can change the names of the Bakin variables that the plugin will use.

• Use Sounds:  The name for the Bakin switch that saves whether Talking Sounds should be played or not.
• Talking Sound: A string variable that stores the name of the current sound or sounds that will be used by the plugin.
• Lower pitch: This float variable stores the lowest pitch range to which the Talking Sound can be randomized. (default: 0.9)
• Higher pitch: This float variable stores the highest pitch range to which the Talking Sound can be randomized. (default: 1.2)
• Sound volume: Float variable that stores the volume to use when playing a Talking Sound, default: 1, but values above this figure can be used if necessary.
• Sound panning: Float variable that stores the panning of the Talking Sound, You can adjust the stereo panning of the sound, left = -1, normal = 0, right = 1.
• Update settings: The name of the switch variable that, when turned on, will make the plugin update its configuration with the variables described above; you only need to turn it on, there's no need to turn it off.  This switch will be activated automatically when you use any C# call in the event panel, so depending on your needs, it might be better to use C# calls without the need to use this switch.

• Create Variables Button: Press this button to create the variables in your project with the default names or the ones you have changed in this section.

Adding sounds to the talking sounds list:

- Use " + "  button to add your talking sounds.

- You can add multiple sounds at the same time.

- You can use 'Select by AssetPicker' and add the sounds to your project from your computer files.

Example:

Remember to save your settings before closing the GUI!

C# Calls:

You can attach "TalkingSounds.cs" to any event, as the system is connected to a single master instance.

List of main functions

* EnableTalkingSound: Talking sounds are disabled by default, so you must use this function with a value of '1' to enable Talking Sounds! (0 = disable, 1 = enable).

* SetTalkingSound: It uses a Bakin String as parameter, Set current talking sound or sounds separated by commas. 

* SetTalkingVolume:  Receives a numeric variable as a parameter, default value: 1.

* SetLowerPitch:  Receives a numeric variable as a parameter, it will the lowest value that the plugin will use in the pitch randomizer, default value: 0.9.

* SetHighestPitch:  Receives a numeric variable as a parameter, it will the highest value that the plugin will use in the pitch randomizer, default value: 1.2.

* SetTalkingPan: You can adjust the stereo panning of the sound, left = -1, normal = 0, right = 1.

*SetTalkingFrequency: Change the frequency at which the Talking Sound is played. The current value is 3; if you use a higher value, the sounds will play at longer intervals per word, so a higher value means less sound frequency.

Notes

* I'm open to suggestions for future updates!

* If you find any bug, do not hesitate to let me know!

* This plugin is paid, you can use it in every project you make in Bakin, but you can't share the plugin or scripts with anyone. (No credits needed)

* Any questions I am always active on official Bakin Discord.