README.md

Arcript

Powerful Not-Only-Arcaea¹ Visual Novel (VN) Script Creator written in Unity and pure C#.

中文版 | English

Copyright Tip: For DMCA takedown request, please see License section

Discussion Area

Welcome to join Arcript Official QQ Group and Discord Server to chat everything about Arcript!

• Official Discord Server: <preparing>
• Official QQ Discussing Group: 827728743

Script Formats

Arcript uses aspt² to store all VN script commands.Every aspt script should be built before they can be used in Arcaea or various supported VN game engine(s).
Arcript provides 2 candidates to build aspt scripts:

• .vns: Plain Script/The original VN Script for Arcaea. Though it is plain script text, it is still not readable enough to be directly edited by human.
• .acpkg: Binary Script/Arcript Script Package. It is binary-formatted & optimized for quick loading by supported VN game engine(s).

Arcript+

Though the whole Arcript Project was started by inspiration from Arcaea VN Story, Arcript doesn't restrain herself to supporting Arcaea VN Story only.
And that's why there is a group of features named Arcript+.

Arcript+ are the features that distincted from Arcript.
Most of them are designed for pure VN Game (such as Galgame) development.

Caution: Arcript+ is not a special edition of Arcript! It is just a name for Arcript-only VN features

Here are some reprenstative Arcript+ features:

• Branch Select(選択支): Provides a way to let player choose their own story route. Usually used in Galgames for different endings. Here is an example screenshot³ of Branch Select feature.
• If Check Statements: Provides a way to let script check the value of a variable and decide which branch to go. Usually used in Galgames for character favorability check.
• Center Screen Text: Provides a way to let script display text in the center of the screen. Usually used in Text Adventure VN Game for story plot setting (or neither dialogue nor thought text).
• Video FullScreen Play: Provides a way to play fullscreen video in VN Game. Usually used in Galgames for OP/ED video play.
• ...and more

Arcript Secondary Development(2nd-D) Interfaces

Arcript provides several interfaces for 2nd-Ds. Here are examples of 2nd-D interfaces:

• Arcript.Data.ICustomImageFormat: Inherit this to create your own image format parser.
  Arcript will attempt to find all classes with ICustomImageFormat interface and ImgFormatExportAttribute attribute in all loaded assembiles, and then load images using found classes.
  • Example: Arcript.FormatExt.Siglus⁴: A Siglus/RealLive⁵ image format (.g00) parser extension plugin for Arcript.
• ...more planning

Contributing Notices

Arcript is still in early developing status. If you want to contribute to this project, just make a valuable Pull Request or Issue to this project.
After the first Arcript version (0.1.0) is released, main development for Arcript will be moved to develop branch.
master branch will only be used for releasing stable versions after it.

License

Arcript main project is licensed under 123 Open-Sourced Organization MIT Public License v2.
Arcript plugins are licensed under their own licenses. See ArcriptPlugins for more information.

It is possible that Arcript may use some textures with copyright during early developing. If this violates your and/or your organization's copyrights, please contact developer, we will remove them ASAP.

Thanks

Thanks all of the following projects for their great works:

• morkt/GARbro: Provides several custom-game-engine resource format parser prototypes.
• xmoezzz/SiglusExtract: A tool to extract resources from game using Siglus/RealLive⁵ VN Game Engine.
• jp-netsis/RubyTextMeshPro: A Ruby Text (Furigana) support plugin for TextMeshPro.
• Cysharp/UniTask: A powerful async/await library for Unity.

And thanks to all people who supports to Arcript project.

Footnotes

1. Arcript+ supports the features that don't supported in Arcaea. These features are named as Arcript+. You can also use Arcript+ features to develop Visual Novel Games instead of put them into Arcaea only. See Arcript+ section for more information. ↩

2. aspt: Arcript Plain VN Script, written in yaml. ↩

3. Example screenshot is a highly-restored screenshot of game 'floral·flowlove' by Saga Planets inside Arcript. See floral·flowlove Official Website and Copyright Tip for more information. ↩

4. Internal Plugin Arcript.FormatExt.Siglus uses codes from GARbro project by morkt. See GARbro Project Repository for more information. ↩

5. Siglus, Siglus Engine, RealLive and RealLive Engine are copyrighted trademarks of Key/Visual Art's. See Key/Visual Art's Official Website for more information. ↩ ↩²