diff --git a/README b/README index a173e58..bda460b 100644 --- a/README +++ b/README @@ -3,18 +3,20 @@ quests is a simple quest framework for minetest that lets you define your own qu You can see a full list of your active quests with the chatcommand /quests API: -quests.register_quest(playername, questname, description, max, autoaccept, callback) +quests.register_quest(playername,questname,quest) -- registers a quest for the specified player -- -- playername is the name of the player, who gets the quest -- questname is the name of the quest to identify it later -- it should follow the naming conventions: "modname:questname" --- description is shown to the player and should contain usefull information about the quest. --- max is the desired maximum --- autoaccept is true or false, wether the result of the quest should be dealt --- by this mode or the registering mod --- when autoaccept is true, at the end of the quest, it gets removed and --- callback is called +-- quest is a table in the following format +-- { +-- title, -- is shown to the player and should contain usefull information about the quest. +-- description, -- a small description of the mod. +-- max, -- is the desired maximum. If max is 1, no maximum is displayed. defaults to 1 +-- autoaccept, -- is true or false, wether the result of the quest should be dealt by this mode or the registering mod. +-- callback -- when autoaccept is true, at the end of the quest, it gets removed and callback is called. +-- } -- -- returns true, when the quest was successfully registered -- returns falls, when there was already such a quest