Stendhal Quest Coding: Difference between revisions

Jump to navigation Jump to search
← Older edit
Content deleted Content added
imported>Hendrik Brummermann
decreased indent
imported>Kribbel
m replace old link
 
(139 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Navigation for Stendhal Top}}
{{Navigation for Stendhal Top|Contributing}}
{{Navigation for Stendhal Contributors}}
{{Navigation for Stendhal Contributors}}
⚫
{{Stendhal Quests}}


{{ TODO | Update page for changes in quest coding }}


⚫
{{Stendhal Quests}}
__TOC__
__TOC__


If you have ideas for new quests or are interested in helping to refine quest ideas, please have a look at the [[Stendhal Quest Contribution|Quest Contributor's Guide]] or the [[Stendhal Quest Ideas]].
If you have ideas for new quests or are interested in helping to refine quest ideas, please have a look at the [[Stendhal Quest Contribution|Quest Contributor's Guide]] or the [[Stendhal Quest Ideas]].



<div style="border: 3px solid green; background-color: #AFA; padding: 1em; margin-right: 20em">
This page is currently reworked. You can find the old content on the [[Talk:Stendhal Quest Coding|talk page]]
</div>


== Before you start ==
== Before you start ==
Line 16: Line 15:
This page describes how to code a quest. You don't need to know a lot about Java. You should, however, already have [[Configure a development environment (IDE)|setup an IDE]] and be able to compile and start a local Stendhal server.
This page describes how to code a quest. You don't need to know a lot about Java. You should, however, already have [[Configure a development environment (IDE)|setup an IDE]] and be able to compile and start a local Stendhal server.


This tutorial assumes that the new quest only uses NPCs and items that already exist in Stendhal.
This tutorial assumes that the new quest only uses NPCs and items that already exist in Stendhal. To add a new NPC, see [[Stendhal NPC Coding]].


== Creating a quest skeleton ==
== Creating a quest skeleton ==
Line 52: Line 51:
public String getName() {
public String getName() {
return "BeerForHayunn";
return "BeerForHayunn";
}

public List<String> getHistory(final Player player) {
final List<String> res = new ArrayList<String>();
return res;
}
}
}
}
Line 103: Line 107:
== Commonly used conversation phrases ==
== Commonly used conversation phrases ==


Good, Hayunn now replies to the trigger "quest". He does not, however, reply to "task". All other NPCs accept both words as synonym. A simple solution would be to add a second ''npc.addReply'' line. But there is a better way which makes it very easy to add additional synonyms later. We predefined lists of commonly used [http://arianne.cvs.sf.net/viewvc/arianne/stendhal/src/games/stendhal/server/entity/npc/ConversationPhrases.java?view=markup ConversationPhrases]. If there are already conversation phrases defined for the triggers that you would like to add, you should use the phrases.
Good, Hayunn now replies to the trigger "quest". He does not, however, reply to "task". All other NPCs accept both words as synonym. A simple solution would be to add a second ''npc.addReply'' line. But there is a better way which makes it very easy to add additional synonyms later. We predefined lists of commonly used [https://github.com/arianne/stendhal/blob/master/src/games/stendhal/server/entity/npc/ConversationPhrases.java ConversationPhrases]. If there are already conversation phrases defined for the triggers that you would like to add, you should use the phrases.


Let's adjust the above sample by using ''ConversationPhrases.QUEST_MESSAGES'' instead of the hard coded word "quest":
Let's adjust the above sample by using ''ConversationPhrases.QUEST_MESSAGES'' instead of the hard coded word "quest":
Line 116: Line 120:
npc.addReply(ConversationPhrases.QUEST_MESSAGES,
npc.addReply(ConversationPhrases.QUEST_MESSAGES,
"My mouth is dry, but I can't be seen to abandon this teaching room!");
"My mouth is dry, but I can't be seen to abandon this teaching room!");
}
}
</source>
</source>


Line 123: Line 127:
== Blue trigger words ==
== Blue trigger words ==


⚫
As you probably know NPCs can say words in blue, words that they expect to be repeated by the player. We want to add such words for "beer" and "tavern". As we have done before, we will add npc.addReply lines for those words.
{{TODO|

⚫
As you probably know NPCs can say words in blue, words that they expect to be repeated by the player.
So, how do we get the words colored blue? Simple, add a "#" in front of them. If you actually want to include a #-character, you need to repeat it.
* #beer

⚫
}}
<source lang="java">
public void prepareQuestStep() {

// get a reference to the Hayunn npc
SpeakerNPC npc = npcs.get("Hayunn Naratha");

// ask for a beer and explain it
npc.addReply(ConversationPhrases.QUEST_MESSAGES,
"Please bring me a #beer.");

// explain blue words
npc.addReply("beer", "Margaret sells beers in the #tavern.");
npc.addReply("tavern", "If you don't know where the inn is, you could ask old Monogenes.");

// an example for escaping #
npc.addReply("trading", "http://stendhal.game-host.org/wiki/index.php/StendhalFAQ##Trading");
⚫
}
</source>

You know the drill: Compile, restart and try it out.


== Second Part of this Tutorial ==
== Second Part of this Tutorial ==


Congratulations if you made it this far. You are now able to code basic dialogs with NPCs. The next section of this tutorial will describe advanced technics. Please make sure the steps on this page work before you continue to [[Stendhal Quest Coding - Part 2|the second part of this tutorial]].
Congratulations if you made it this far. You are now able to code basic dialogs with NPCs. The next section of this tutorial will describe advanced techniques. Please make sure the steps on this page work before you continue to [[Stendhal Quest Coding - Part 2|the second part of this tutorial]].




Retrieved from "https://meet.konsthol.eu/w/index.php?title=Stendhal_Quest_Coding"