Getting Started

Beginners Guide

If you are a beginner with Quillscript Plugin, this article helps you start from scratch.

Follow the steps below to get your project up and running and create your own stories.

You can also download our sample project.

Step by Step

Setup your Project

  1. Add Quillscript Plugin to your Engine through the Epic Games launcher.

  2. Create and start a project.

  3. Go to Edit > Plugins > Installed > Gameplay and enable "Quillscript Plugin".

  4. Restart your Editor.

Write your Story

  1. Create a plain text file using your preferred text editor software and write your story following Quillscript Language rules. Save it with a .qsc extension.

  2. Drag your script file into Unreal Editor's content browser. A Quillscript Asset will be generated.

We provide sample scripts you can use to test and experiment.

Play your Story

Go where you want to start your story, add a Play Script node, and select your new Quillscript Asset.

For Blueprint

For the sake of this guide, we're starting the story at the Begin Play event of the open Level, but you can use this node wherever fits your case better, like a collision box overlapping event or button click event.

For C++

#include "Utils/Quill.h"
...

TObjectPtr<UQuillscriptAsset> Script{ UQuill::GetScriptById("MyScriptId") };
UQuill::PlayScript(WorldContextObject, Script);

Play your game, and watch your story happen

Video Tutorial

Where Should I Go Next?

The recommended next step is to familiarize yourself with the base language elements: Dialogue, Option, Label, Router, Command, Condition, Directive, Tag, and Comment.

When you feel confident that you know and understand the basics of each language element, we recommend you move to Guides or Coding and Design sections.

Neither of those sections is required to be read in order; they are meant to be standalone guides, although often, it is considered that you have a basic understanding of prerequisite elements.

Last updated