PoiGalgame

Overview

PoiGalgame is scripted framework to build galgames or adventure games based on Unity.

There are some famous galgame development engine such as KIRIKIRI, NScriptor, YU-RIS, Siglus&RealLive and etc. It seems that using Unity engine to galgame developement just like employing a steam engine to crack a nut. But small as the sparrow is, it possesses all its internal organs. To build a excellent galgame with Unity, a great quantity of work should be done.

WARNING: This project is still under development!

Support

• Dev Eviroment
  • Windows 10
• Dev Tools
  • Unity 2020.1.0f1
  • Microsoft Visual Studio 2017
  • Microsoft Visual Studio Code

Development Goals

• Basic Galgame elements
• Visual editing script framework
• Create a more readable script(like kirikiri)
• Provide a custom script editor tool: KsEditor
• Script update behavior monitoring (to be evaluated)
• Real-time parsing, previewing and presentation
• Tranform, animation, effect, etc.
• Full documentation

Getting Start

WARNING: This project is still under development!

1. Write your own script and translate to Unity asset.
   1. Write your story using KsEditor.
   2. Export KS script(suffix with .ks) from KsEditor by clicking EXPORT button.
   3. Place the exported KS script in the unity folder Assets/Resources/Chapter.ks(recommended) or other folder.
   4. Open Scene Translator in unity editor mode and input full path of KS script file in step3, then click button: スクリプト翻訳.
2. Load script in ChapterController. find the following line and change the path Chapter/Chapter-01

currentScript = Resources.Load<GalgameScript>("Chapter/Chapter-01");

Releases

WARNING: This project is still under development!

• Pre-release built using Scene ChapterDisplay.

Documentation

• Script Mask Documentation
• Framework Documentation
• Key Issues Record

Declaration

Some resources using in the demo are from game CLANNAD, which copyright to Key company. All other resources in this project are based on CC BY-NC-SA 4.0, that means you can copy and reissue the contents of this project, but you will also have to provide the original author information as well as the agreement statement. At the same time, it cannot be used for commercial purposes. In accordance with our narrow understanding (Additional subsidiary terms), all activities that are profitable are of commercial use.

Released under the Apache License 2.0

Copyright © RyougiChan