VISUAL NOVEL/RPG CONVERSATION SYSTEM
DEVELOPED FOR UNITY3D BY BLAKE KENDRICK
Version 1.0
CONTENTS
Introduction ............................................................................................................................................................ 4 Features .............................................................................................................................................................. 4 Getting Started ....................................................................................................................................................... 4 Importing The Package ....................................................................................................................................... 4 Folder Breakdown............................................................................................................................................... 5 Object Types ....................................................................................................................................................... 5 GUI Camera ..................................................................................................................................................... 6 Character ........................................................................................................................................................ 6 Background ..................................................................................................................................................... 6 Dialog Box ....................................................................................................................................................... 7 Sounds ............................................................................................................................................................ 7 Managers ........................................................................................................................................................ 7 Samples ............................................................................................................................................................... 8 In Game Sample – ........................................................................................................................................... 8 Sample Cutscene – .......................................................................................................................................... 8 Tester - ............................................................................................................................................................ 8 Tutorials .................................................................................................................................................................. 9 Tutorial - Setting up a traditional VN styled System ........................................................................................... 9 Tutorial – Creating a New Character ................................................................................................................ 11 Tutorial – Creating a new Background.............................................................................................................. 13 Tutorial – Creating a Conversation Script ......................................................................................................... 14 Tutorial – Creating a Custom Dialog Box .......................................................................................................... 18 Tutorial - Setting up an Inline Speech System .................................................................................................. 20 Tutorial – Setting up in a Game ........................................................................................................................ 21 Notes on making Scripts for NPCs ................................................................................................................ 23 Code Notes On NPCs..................................................................................................................................... 23 Custom Dialogs In This Method .................................................................................................................... 23 Additional Notes ................................................................................................................................................... 24
2
Resources .......................................................................................................................................................... 24 Formats ............................................................................................................................................................. 24 Possible Extensions ............................................................................................................................................... 24 Keyboard Controls ............................................................................................................................................ 24 Conversation History ........................................................................................................................................ 25 Scroll Bar For Inline Choices ............................................................................................................................. 25 Known Bugs .......................................................................................................................................................... 25 Unable to find Character .................................................................................................................................. 25 Save Sometimes Breaks .................................................................................................................................... 25 Special Thanks ...................................................................................................................................................... 25 Contact ................................................................................................................................................................. 26
3
INTRODUCTION
This tool is designed to enable you to quickly implement a conversation system. This tool is designed for use in Visual Novel and RPG style games. However I see no reason why it can’t be used in any game that requires a speech solution.
This tool is designed to enable you to quickly implement a conversation system in any kind of game you can think of! Primarily designed to produce Visual Novels this easy solution will enable you to add conversations with choice and consequence with ease.
FEATURES
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
XML parsing of custom scripts
Fully integrated character manager/editor. Auto/Skip button functionality Player character thought parsing. Scene management.
Questions with answers leading to different paths. Save/Load functionality. Matching voice to lines. Scene dependent music. In-line responses.
Basic conversation editor. In-line conversations.
Auto-close of the dialog box Close button.
Can now load characters from resources to save Scene clutter when designing.
Fixed a ton of bugs and made it Web-Player friendly once again by adding a 'Save Enabled' toggle for web.
Full custom conversation editor. Custom Inspectors
GETTING STARTED
The first thing you will want to do is import the package.
IMPORTING THE PACKAGE
If not automatically imported when selecting from the Asset store follow the steps below.
1. From unity select Assets>Import Package>Custom Package. 2. Navigate to where you downloaded the .unitypackage file. 3. Click Open.
You should now have imported the package and the project tab should look something like below:
4
Now you have imported the package feel free to look around.
FOLDER BREAKDOWN
Documentation – Contains the documentation that you are reading now, plus a changelog and generic readme. Editor – This folder contains the various helpers and editor extensions.
Fonts – A selection of fonts that are used in the samples, can be deleted or replaced as needed. GUI – Some default graphics for the GUI, I have two different styles for you to use. Prefabs – These are some ready to go assets; drag them into the hierarchy to seem them.
Resources – As a rule of thumb it is recommended that you put any assets such as backgrounds, characters, sounds or music in your resources folder so the scripts can find them without having to clutter up your hierarchy.
Save – The default save location for save files.
Scenes – In here are the default sample scenes, you can delete these, but it is worth looking at them to get a better understanding of the system.
Scripts – All the scripts used in the system. Feel free to look around these and edit them where you need to, I have commented the majority of the code, but you shouldn’t need to edit much.
XML Scripts – This is when the speech files are stored by default when using the speech/dialog editor.
OBJECT TYPES
5