There is a video tutorial covering the creation of a Visual Novel game with BGS.
It is assumed that you have read the documentation for Blox Game Systems before you continue with the documentation for this plug-in.
Follow the BGS setup and then import the VN Engine after that is done.
Remember to do a Data Check after adding this plug-in, as required with all BGS plug-ins
menu: BGS > Check Game Data. The VN Engine adds new Sorting Layers. These can be seen in the Tags and Layers Inspector
menu: Edit > Project Settings > Tags and Layers.
There should be Sorting Layers for:
The VN Engine adds a new component
menu: Component > BGS > VN > VN Engine. This must be placed on a GameObject of your main Unity scene and controls various aspects of the engine.
There will normally be only one Unity scene which contains the main controller and your UI. All dialogue and story is created in the FlowGraph editor and you point to the start of your VN (the graph to start with) via the main controller.
VN Engine > Start New GameFlowGraph node.
The VN Engine nodes can be found under the
VN Engine category.
The VN Engine adds a new [Test Scene] button to the FlowGraph toolbar. Use this to quickly test the active Global FlowGraph. It is like pressing the Unity play button so the scene with the VN Engine controller in it should be open. You may also use the drop-down to choose whether the graph should execute from the Start node or from the currently selected node. Keep in mind that there could be errors if you choose to execute from a node which depends on previous nodes having made changes to the scene.
The VN Engine adds a new tab to the main editor where some settings can be changed and data defined.
Here you define the characters who will appear in the scene. The
VN Engine > Character Action FlowGraph node will be used to access this list of characters. This action can make a character enter or exit a scene and change the character’s pose.
Press the [+] to add a new character definition. If there are no groups yet you will first create a group where new character can be added to. The name you give a character must be unique and is the name you will see in other areas of the editor, for example the Character Action node’s Inspector. It is not a name shown in the game UI.
Add a character prefab to complete the setup of a new character.
Characters are GameObject containing sprites which represents the various poses of that character. The main object will normally have no components attached and then contain one or more GameObjects, each with a SpriteRender. The “pose” objects may contain further child objects with SpriteRenderers if the pose is built from various sprites. You do not have to setup the layer options of the SpriteRender since the VN Engine will take care of these when the character is shown.