Home

Description

PixelBuilt-Quests (or PBQ) is a fully customizable quests plugin that was initially made for the PixelBuilt server. It contains several possibilities for quest requirements, tasks, rewards and etc. This wiki will help you setting up a basic to complete configuration of PBQ.

Getting Started

PBQ uses SQL to store data related to triggers, players progress and etc, and by default uses SQLite with a file called PixelBuiltQuests.db on your root server directory. If you want to change your db, do it via the database URL in the plugin's main config.

The Environment

When loading the plugin for the first time, it should generate the tasks, quests and rewards folders. Inside each one, guess what? They're where the tasks, quests and rewards files are stored.

All those folders contain cataloged files, which means that they represent all the content that is available on PBQ, from the base plugin AND all addons. So, all files inside tasks are valid tasks for quests, all files in rewards are valid rewards and so on. The name of the file represents its ID, the name that you should use when using those tasks/rewards in quests.

• Task Files The Task Files are in the tasks folder named with their ID, like cost.conf. They are the requirements to complete a Quest. Each Task has (or may have) options such as an item or a cost amount, for example. See the default tasks.

• Reward Files The Reward Files are in the rewards folder named with their ID, and are the available rewards that you can add to quests, like a command execution or an item. See the default rewards.

• Quest Files Quest files are in the quests folder named with their ID, that should be numeric, like 0.conf. They are the main part of the PBQ configuration, see how to configure them in Quest Files. Quests are tied to Quest Lines, which are explained below.

Plugin files

• QuestLines.conf: this is where quest lines are stored. An quest needs to be put on a quest line to work. The player progress system is tied to quest lines. The file contains a list of lines as follows:

    questLines=[
        {
            name=default
            quests=[
                0
            ]
        },
        {
            name=kanto
            quests=[
                1,
                2
            ]
        }
    ]

Each quest line has a name and a list of quests. Those quests are the numerical IDs of quests defined in the quests folder. Quest lines can share the same quest. After creating a new Quest, you must remember to add it here!

• PBQuests.conf: this is the plugin's main file, where you can edit the plugin's default messages and the storage options.