Skip to content

Latest commit

 

History

History
117 lines (93 loc) · 4.71 KB

README.md

File metadata and controls

117 lines (93 loc) · 4.71 KB
Raw

XGVolcanoLink

Plugin Version:1.0

Brief

  This is XGVolcanoLink project,which it helps to connect VolcEngine with UnrealEngine 5.
  At pressent,It contains some functions :
  Text To Speech
  TODO more...
  It contains two parts:
  "Picture":There are some pictures used by this document.
  "XGVolcanoLinkDemo":The project shows you how to quickly use this plugin.Before you start it,you should purchase the plugin and install it to UnealEngine 5.Then,you should prepare some necessary resources(text,auido,img...).You must register your App info from VolcEngine Web by yourself.
  UE Marketplace URL:
  XGVolcanoLink-TODO
  Chinese Instruction URL:
  中文说明书-TODO
  VolcEngine Web URL:
  VolcEngine

Get App Information

  If you don't create the VolcEngine App,you should create it.
  After you create the App, you should enable corresponding function in your VolcEngine control panel,such as TTS.
  You have to get some App informat,such as AppID,Token.....
  Be careful that some functions are not free.Howover,You can try it for free in a short time.

Browse The Plugin From UE

  You can quickly learn which method and documentation each API corresponds to.

image

Functional Detail

TTS

  URL:https://www.volcengine.com/docs/6561/79820
  You can choose different speakers, different emotional styles, different languages by entering different parameters.
  For the parameter list, refer to the official website.
  You can keep the default for test.

image

XGVolcanoLinkDemo

  1.App info shoulud be input "Content/GameFrame/BP_XGVolcanGameInstace"

  2.All BP methods are in "Content/GameFrame/BP_ShowCode"

  3.All buttons are in "Content/UI/WBP_MainUI"

  4.Some nodes need to temporarily prepare pictures, audio and other resources in the Saved directory of the project for testing, and specify the file location in the blueprint node. If the test is packaged, you also need to copy the same resource in the packaged path;

  5.More methods will be added;

Framwork

  XGVolcanoCoreModule:
  Common API exposed to other module

  XGVolcanoTTSModule:
  TTS Module

  XGVolcanoLinkModule:
  It contains UE C++ API

  XGVolcanoOtherModule:
  ......(to be added)

  C++API:
  ......\Plugins\XGVolcanoLink\Source\XGVolcanoLink\Public\XGVolcanoLinkBPLibrary.h
  Other API is highly customized.
  It may be not good for the general design.
  Remember it:
  If you use C++ API,you should add the modules to your "*.build.cs".

public class XGVolcanoDemo : ModuleRules
{
	public XGVolcanoDemo(ReadOnlyTargetRules Target) : base(Target)
	{
		PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
	
		PublicDependencyModuleNames.AddRange(new string[] { 
			"Core", 
			"CoreUObject", 
			"Engine", 
			"InputCore","
			 XGVolcanoLink",
			"XGVolcanoCore",
			"XGVolcanoTTS",
			"XGVolcanoOther......"
        });

		PrivateDependencyModuleNames.AddRange(new string[] {  });


	}
}

Package

  Windows:[5.0-5.3].
  Andriod:Only version 5.3 has been tested.

Other

  This plugin does not contain any VolcEngine's files(*.h,*.cpp,*.lib,......)

  This plugin does not contain AI code or AI Model code.

  This plugin will not send any data to the plugin author.

  his plugin was not developed by VolcEngine.

  This plugin will only send the interactive data to VolcEngine and recieve the message from VolcEngine . This plugin will not generate any data directly.You must comply with the relevant user and data usage agreements about VolcEngine.These agreements can be found in the VolcEngine website.

  If the plugin is useful for you. Please purchase it in Unreal Engine Marketplace.

  Thanks a lot.

Contact Information

  Please contact me if you have any questions about XGVolcanoLink-todo.

  QQ:
  709777172

  Email:
  709777172@qq.com

  bilibili:
  虚幻小刚