QuestManager for Ren'PY

About

QuestManager is a framework specialized in managing quests and events for Ren'Py. Create and manage quests for your game with powerful tools that limit the amount of code for your project. The framework is easily customizable and suitable for novice programmers.

You can use it for:

• Create quests and events (with a name and ID).
  
• Classify these quests and events into categories (make a To Do list).
• Group the categories into chapters allowing you to divide your game into different chapters (like a book or a movie by Q. Tarantino )
• Assign a "status" to each quest (hidden, unlocked, in progress, completed, done, cancelled, failed)
• You can trigger events depending on the progress of a certain quest (start a dialog if a quest is completed, start a dialog if all quests of a category are completed, move to another chapter if all quests of the chapter are completed, etc.)
• Included are many functions to sort and organize your quests within your game.
• A 100% customizable diary interface.
• Free and OPenSource!

OS: Window, Mac Linux, Android

How  to install the framework in your game

Adding the framework in your game

1. Download the framework with the download button at the end of this page.
2. Unzip the QuestManager.zip file to your home.
3. Go to the QuestManager file and copy the questmanager folder
4. Past it into game folder of your project

Activating the framework in your script

To use the framework you must initialize it in your game code ! 

Open the main script of your game where the start label is located. Usually this label is located in the script.rpy file

• In your script.rpy file add the following line before label start:

default quest = Manager()

Displaying the diary screen

You can display the log at any time by adding the following code anywhere between your dialogs:

show screen diary

Example:

You can display a button to let the player open the diary.  Add the below code after the label start in your script.rpy file

show screen diary_open_btn

You can customize the button by creating new background image or in the questmanager/gui.rpy file. 

Getting Started

Create a new quest

To create a new quest you must follow the following syntax:

Quest("id", "title", "category", "state")

or if you allow the Ren'Py translation

Quest("id", _("title"), _("category"), "state")

1. The id is a string not displayed in the game. It allows the algorithm to find a quest in the chapter. It must be unique for each quest.
2. The title of the quest is displayed in game. It is only meant to be displayed in the game. The algorithm does not use the title. The title must be contained between _() to allow renpy to do translations (don't forget the underscore before the parenthesis)
3. The category is also displayed in-game and is also used by the algorithm to rank the quests. It is also a string contained between _() for the translation
4. The state is a string not displayed in game. The default state is "pending" but you can optionally add it if you want another default state.

By default when you create a new quest, it will be in the "pending" state and hidden with ??? in the diary.  You can modify this default state by adding a new state in string form

List of all the states

"pending"	Default state!  The quest is posted in the diary but the text is hidden by ???
"unlocked"	The quest is displayed in the diary.
"in progress"	The player is doing the quest.
"completed"	The player has completed the quest but must return to the Non-Player Character to validate it.
"done"	The quest is over.
"canceled"	The quest is cancelled and the player cannot start it again (it is removed from the chapter).
"failed"	The player has failed to complete his quest.

You can customize state display in the questmanager/gui.rpy file

Exemple:

Create a new chapter

Chapters are arrays that contain all the quests that the player must complete. You can create a single chapter for your entire game. But if your game is very long, we recommend you to create several chapters like in a book, so that the player can better find his way through the game.

All chapters must be declared after the default quest = Manager() line and before the start label !

your_chapter = (your_quest1, your_quest2, your_quest3)

/!\ Don't forget the commas between the quests

Example:

chapter01 = (
            Quest("id01", _("Introduction"), _("General")), 
            Quest("id02", _("First dialog"), _("General")),
            Quest("id03", _("New category"), _("Category 1")),
            )

Functions to manage your quests

The following functions allow you to manipulate your quests. You can test their status, whether they are completed or not, trigger actions and dialogs depending on the player's progress in their quests, etc.

You can add them directly after your characters' dialogues. Don't forget to add the $ sign before each function.

Loading and deleting chapter into the manager

• Load the chapter into the manager memory.

$ quest.load(chapter_name)

• Delete the chapter from the manager memory.

$ quest.free()

Functions to do some tests

These different functions allow you to perform actions according to the progress of the quests. They are useful to start a dialogue or an action when the player talks to a npc.

• Return True if the category exists in the chapter

$ quest.exists("quest_id")

• Return the category
  

$ quest.is_in("quest_id")

• Return True if the ID has the right state
  

$ quest.is_state("quest_id", " quest_state")

• Return True if all the events of a category are done

 $ quest.is_category_over("your_category")

• Return True if all the events from all the categories into the chapter are done
  

$ quest.is_chapter_over()

Some functions to change the state of quests

The following functions allow you to manipulate the status of quests. For example, when the player has completed a quest, you can use these functions to validate the current quest and unlock the next quests.

• Check if the event has the right state, otherwise it is updated

 $ quest.check("quest_id", "quest_state")

Example

The quest.update() function is a little bit tricky to use ! 

The update function allows you to manage several quests at the same time. It is very powerful but can be quite complicated to use for beginners.

Its syntax is as follows:

$ quest.update(id="", state="", unchanged = [], category="")

Yes, it looks terrible, but I will explain how it works ;)
Imagine you have a category with 10 quests. You can handle these quests in different ways.

• changing all the quest state from the first quest to the target id

## example
$ quest.update("quest07", "unlocked")

>> All the quest from quest01 to quest07 are unlocked

• Changing the state from a quest to another

## example
$ quest.update(("quest02", "quest05"), "unlocked" )

>> All the quests from the number 2 to the 5 are unlocked

• Changing the state from a quest to another but the last one has a different state than the previous one.

## example
$ quest.update(("quest02", "quest05"), ("completed", "unlocked"))

>> All the quests from the number 2 to the number 4 are completed and the number 5 is unlocked

• Changing the state from a quest to another but you can exclude one state.

## example
$ quest.update(("quest02", "quest05"), ("completed", "unlocked") , ["failed"])

>> All the quests from the number 2 to the number 4 are completed and the number 5 is unlocked but if a quest is failed it is not updated.

• Changing the state from a quest to another but you can exclude several states.

## example
$ quest.update(("quest02", "quest05"), ("completed", "unlocked"), ["failed", "completed"])

==> All the quests from the number 2 to the number 4 are completed and the number 5 is unlocked but if a quest is failed  or completed it is not updated.

• Update all quests in a category but exclude those with a certain state.

## example
$ quest.update(category="my_category" , state="completed", unchanged= ["failed", "completed"])

>> All the quests in the category my_category are updated to competed but if a quest is failed  or completed it is not updated.

Adding or removing categories from the chapter

You can add or remove categories or quests during the game. But when a chapter is freed it returns to its original state.

1. Adding a new category into the chapter during the game  (The added categories will not be stored when the chapter is freed)

$ quest.add(your_new_quest)

• Adding multiple quests

$ quest.add([your_quest01, your_quest02, your_quest03])

example:

$ quest.add([
            Quest("intro01", _("Add an event 1"), _("Introduction")), 
            Quest("intro02", _("Add an event 2"), _("Category")),
        ])

• Removing a category from the chapter

$ quest.remove("your_category_name")

Customize

You can easily customize the diary interface. Open the questmanager/gui.rpy file.

The code is commented to allow you to easily modify it. You can set the number of categories and quests that should be displayed on the left page and on the right page. You can change the fonts, text size, style of each state, etc.

Lastly...

If you have any question, feel free to ask me in comments ;)

init python:
    import collections
    class Quest ():
        def __init__(self, id, title, category, description, requirement, state= "pending"): 
            self.id = id
            self.title = title
            self.category = category
            self.description = description
            self.requirement = requirement
            self.state = state

define prologue_quest = (
                    Quest("old_friend", _("Old Friend"), _("Prologue"), "Meet up with Jack.", "None", "unlocked"),
                    Quest("betrayer_on_the_hills", _("Betrayer on The Hills"), _("Prologue"), _("Assassinate The Enforcer. Leave no evidence."), _("Completed old_friend")),
                    # Quest("id", _("title"), _("category"), _("description"), _("requirement"), "state"),
                    )

text "~ "+__(cat)+" ~":

text __(cat):

Did you solve this problem? If yes, please tell me how you did it.

I already figured it out myself, thanks u anyway :)