Bukkit

Getting Started

Configuration

The Configuration folder holds the following files and these can be edited to your liking, the files contain comments on what each value represents, for those whcih are not self explanatory.

• npc_world_config.txt (Configuration options related to NPC spawning/despawning)
• general_config.txt (General configuration options)
• sql_logging_config.txt (Configuration options related to SQL logging of ChunkPopulationDensity)
• poll_config.txt (Configuration options for erasing NPC task and Quest progression allowing players to completed tasks/quests multiple times. File format is explained in comments inside the file.

Things to do First

So you have just installed QuestX on your server. The settings in the configuration files are self explanatory and those that aren't have been commented on. To make sure NPCs can spawn you will need to make sure the SPAWNABLE_WORLDS key has the world name you want to spawn in its values. By default this is set to 'world', however if for whatever reason you have renamed your worlds this property will need to be changed. For example say I have the worlds 'world', 'world_nether' and 'world_the_end'. If you only want NPCs spawning in world 'world' then your config for SPAWNABLE_WORLDS should look like this.
SPAWNABLE_WORLDS:world

For multiple worlds just seperate the names with commas, with no spacing. For exaple if you want NPCs to spawn in world 'world' and 'world_nether' your config should look like this.
SPAWNABLE_WORLDS:world,world_nether

This is all explained in comments in the config file, it is just here for the sake of clarity. Besides from this one property you can just install QuestX and everything should run smoothly.

NPCs

QuestX comes prepacked with numerous NPCs. Each NPC has various files which can be edited to change their behaviour and settings, these are explained on the Documentation page.

When you first start your server all of the NPCs which come included with the plugin will be extracted into the relevant directory. You can add your own NPCs if you wish and I would encourage you to share them in the forum so that I can maybe include them in the plugin if they are a good fit.

Documentation on creating your own NPCs can be found here.
Download NPCs created by other users.
Need help creating your own NPCs?

Spawning

There are a number of factors which will determine, how, when and where an NPC will spawn. The main factor in determining random spawns is 'Chunk Population Density'. Every 3 minutes (default setting) the occupied chunks, that is chunks containing players will be logged to the database. This setting can be edited in the file '/plugins/QuestX/Configuration/sql_logging_config.txt'. So the chunks which are the most frequently populated with players will spawn NPCs in before other chunks do, we don't want NPCs spawning out in the wild where no one would find them. So for this type of spawning you don't have to worry about anything, over time (a few days) your server should be properly calibrated and then you will start to see better spawning results.

Fixed Spawns

Fixed spawns are a way to ensure NPCs always spawn in the same location, this is important if you want to have an NPC who is involved in a Quest or maybe who talks new players through the rules. Fixed spawns will not be included in dynamic spawning and will all spawn instantly when your server is started. For creating fixed spawn locations see the command documentation page.

Hotspot Spawns

Hotspots are provided as a way to ensure certain areas are populated with NPCs first, similar to dynamic spawning. Every hotspot will be populated with NPCs before dynamic spawning begins. For instance you may want to create hotspots at key locations where you know there will be a high volume of players, such as at your server's spawn location.

Each hotspot must have an individual name to identify itself and take two addition paramaeters, these are <range> and <maxspawns>. The range dictates how far out the hotspot reaches (in blocks). So if the range is set to 10, the hotspot will enclose a 10x10 block area centered about the location you were at when the command was executed.

The max spawns parameter determines the maximum number of NPCs which will spawn in the hotspot, this is unaffected by the maximum NPCs per chunk setting in the configuration.

Quests

As the name suggests QuestX is, a questing plugin. Currently there is only one short Quest included with the plugin but I will add more in future updates. Like NPCs ,Quests can be edited and you can even make your own. If you need help setting these up head over to the Quest help forum.

Unlike NPCs if you are adding your own Quest which does not come included with the plugin you need to include the files and folders in a zip file as explained on the documentation page. Then when you are in game you need to 'unpack' or 'unzip' the quest file by running the command /questx quest unpack <name> and then you can setup the quest as normal by using the /questx quest setup <name> and /questx quest next commands.