01_Tutorial_part_1.cfg

#textdomain wesnoth-tutorial

# wmlscope: set export=no

# wmllint: directory spelling quintain

[tutorial]
    id=tutorial
    #po: Hello, translators! The tutorial is meant to be a bit funny at the start,
    #po: welcoming new players. Please keep the friendly fun feeling!
    #po: If you have any questions, ask in the forums or in the #wesnoth-dev channel on the Freenode IRC network.
    name= _"Wesnoth Tutorial Part I"
    map_data="{campaigns/tutorial/maps/01_Tutorial_part_1.map}"
    turns=12
    next_scenario=2_Tutorial
    victory_when_enemies_defeated=no

    {DEFAULT_MUSIC_PLAYLIST}
    [music]
        name=elf-land.ogg
        play_once=yes
    [/music]

    {DEFAULT_SCHEDULE}

    [side]
        type=Fighter
        id=student
        name= _"Konrad"
        profile=portraits/konrad.png
        save_id=human_player
        persistent=yes
        gold=100
        canrecruit=yes
        side=1
        controller=human
        facing=se
    [/side]
    #! -- No leader means NO DESCRIPTIONS. Period.
    [side]
        no_leader=yes
        side=2
        controller=ai

        [ai]
            {AI_SIMPLE_ALWAYS_ASPECT caution 0}
            {AI_SIMPLE_ALWAYS_ASPECT aggression 1}
            [goal]
                [criteria]
                    id=student
                [/criteria]
                value=10
            [/goal]
            [goal]
                [criteria]
                    id=Delfador
                [/criteria]
                value=.1
            [/goal]
        [/ai]
    [/side]

    [side]
        no_leader=yes
        side=3
        team_name=1
        controller=null

        [unit]
            id=Delfador
            name= _"Delfador"
            type=Elder Mage
            profile=portraits/delfador.png
            x,y=13,6
            facing=nw
            {IS_HERO}
            [modifications]
                [object]
                    [effect]
                        apply_to=new_animation
                        [extra_anim]
                            flag=summon_quintain_raise_staff
                            start_time=0
                            [frame]
                                image="units/human-magi/elder-mage-ranged[1~3].png:100"
                            [/frame]
                        [/extra_anim]
                        [extra_anim]
                            flag=summon_quintain_lower_staff
                            start_time=0
                            [frame]
                                image="units/human-magi/elder-mage-ranged[3~1].png:150"
                            [/frame]
                        [/extra_anim]
                    [/effect]
                [/object]
            [/modifications]
        [/unit]
    [/side]

    [event]
        name=prestart
        [store_unit]
            [filter]
                id=student
            [/filter]
            variable=student_store
            kill=yes
        [/store_unit]

        [objectives]
            side=1
            summary= _"You will learn the basics of:
<small>• Movement
• Attacking
• Healing
• Recruiting</small>"
            [objective]
                description= _"Destroy a fierce enemy"
                condition=win
            [/objective]
            [objective]
                description= _"Get yourself killed"
                condition=lose
            [/objective]
        [/objectives]
    [/event]

    [event]
        name=start

        # We don't want players ending their turn before the requisite actions have been completed
        # Therefor, we frequently disallow or allow end turn as needed
        [disallow_end_turn][/disallow_end_turn]

        # TODO: possibly convert to a custom gui2 dialog
        [message]
            speaker=narrator
            message= _"Who would you like to play?"
            [option]
                message="&" + "units/konrad-fighter.png" + "=" + _"Konrad"  # wmllint: no spellcheck
                [command]
                    {VARIABLE gender male}

                    [unstore_unit]
                        variable=student_store
                    [/unstore_unit]
                [/command]
            [/option]
            [option]
                message="&" + "units/human-princess.png" + "=" + _"Li’sar"  # wmllint: no spellcheck
                [command]
                    {VARIABLE gender female}

                    [unit]
                        type=Fighteress
                        side=1
                        x,y=9,6
                        profile=portraits/lisar.png
                        id=student
                        name= _"Li’sar"
                        canrecruit=yes
                        facing=se
                        to_variable=student_store
                    [/unit]

                    [unstore_unit]
                        variable=student_store
                    [/unstore_unit]
                [/command]
            [/option]
        [/message]

        {CLEAR_VARIABLE student_store}

        {GENDER (
            [message]
                speaker=narrator
                caption= _"Welcome to Wesnoth!"
                image=wesnoth-icon.png
                message= _"For this tutorial, you are playing Konrad.
You are standing on the keep, and your mentor Delfador is on the east side of the river." +
                {CONTINUE_MSG}
            [/message]
        ) (
            [message]
                speaker=narrator
                caption= _"Welcome to Wesnoth!"
                image=wesnoth-icon.png
                message= _"For this tutorial, you are playing Li’sar.
You are standing on the keep, and your mentor Delfador is on the east side of the river." +
                {CONTINUE_MSG}
            [/message]
        )}

        {GENDER (
            {PRINT (_"Left click on Konrad")}
        ) (
            {PRINT (_"Left click on Li’sar")}
        )}
    [/event]

    # HP stat tracking
    [event]
        name=side 1 turn,attack_end
        id=hp_stat_tracking
        first_time_only=no

        [lua]
            code= <<
                local unit = wesnoth.get_units({id = "student"})[1]
                local hp_diff = unit.max_hitpoints - unit.hitpoints

                if hp_diff > 7 then hp_diff = 8 end

                wesnoth.set_variable("student_hp", unit.hitpoints)
                wesnoth.set_variable("student_hp_heal_amount", hp_diff)
            >>
        [/lua]
    [/event]

    [event]
        name=select
        [filter]
            side=1
        [/filter]

        {CLEAR_PRINT}

        {GENDER (
            [message]
                speaker=narrator
                message= _"<big>You have selected Konrad.</big>
The places he can move to are highlighted." +
                {CONTINUE_MSG}
            [/message]
        ) (
            [message]
                speaker=narrator
                message= _"<big>You have selected Li’sar.</big>
The places she can move to are highlighted." +
                {CONTINUE_MSG}
            [/message]
        )}

        {GENDER (
            [message]
                speaker=narrator
                message= _"Move Konrad next to Delfador. Note that you can always press <b>u</b> to undo a move if you move to the wrong place."
            [/message]
        ) (
            [message]
                speaker=narrator
                message= _"Move Li’sar next to Delfador. Note that you can always press <b>u</b> to undo a move if you move to the wrong place."
            [/message]
        )}

        {PRINT (_"Left click on a hex adjacent to Delfador to move there")}
    [/event]

    [event]
        name=moveto
        [filter]
            side=1
            [filter_adjacent]
                id=Delfador
            [/filter_adjacent]
        [/filter]

        {CLEAR_PRINT}

        [message]
            speaker=student
            message= _"Good morning, Delfador! Is it time to attack things?"
        [/message]

        [message]
            speaker=Delfador
            message= _"Um, well..."
        [/message]

        [message]
            speaker=student
            message= _"Have you found an orc for me to fight, huh? A troll?"
        [/message]

        [message]
            speaker=Delfador
            message= _"Quiet! I will summon an enemy for you..."
        [/message]

        [scroll_to_unit]
            id=Delfador
        [/scroll_to_unit]

        [animate_unit]
            [filter]
                id=Delfador
            [/filter]
            flag=summon_quintain_raise_staff
        [/animate_unit]

        [sound]
            name=lightning.ogg
        [/sound]

        [color_adjust]
            red=100
            green=100
            blue=100
        [/color_adjust]

        [animate_unit]
            [filter]
                id=Delfador
            [/filter]
            flag=summon_quintain_lower_staff
        [/animate_unit]

        [color_adjust]
            red=0
            green=0
            blue=0
        [/color_adjust]

        [unit]
            id=Quintain
            type=Quintain
            ai_special="guardian"
            x,y=13,5
            side=2
        [/unit]

        [message]
            speaker=Delfador
            message= _"... this quintain!"
        [/message]

        [message]
            speaker=student
            message= _"A quintain? You want me to fight a dummy?"
        [/message]

        {GENDER (
            [message]
                speaker=Delfador
                message= _"You have $student_hp hitpoints and a sword, boy. I’m fairly sure you’ll win."
            [/message]
        ) (
            [message]
                speaker=Delfador
                message= _"female^Young lady, you have $student_hp hitpoints and a sword. I’m fairly sure you’ll win."
            [/message]
        )}

        # wmllint: local spelling OK
        {GENDER (
            [message]
                speaker=narrator
                caption= _"Attacking"
                image=wesnoth-icon.png
                message= _"To attack the quintain, first select the attacker (Konrad) then the target (the quintain). You will see an attack description. When you click <b>OK</b>, Konrad will attack."
            [/message]
        ) (
            [message]
                speaker=narrator
                caption= _"Attacking"
                image=wesnoth-icon.png
                message= _"To attack the quintain, first select the attacker (Li’sar) then the target (the quintain). You will see an attack description. When you click <b>OK</b>, Li’sar will attack."
            [/message]
        )}
    [/event]

    # First time the student attacks the quintain
    [event]
        name=attack_end
        first_time_only=yes
        [filter]
            id=student
        [/filter]

        [message]
            speaker=student
            message= _"Hey! This quintain fights back!"
        [/message]

        [message]
            speaker=Delfador
            message= _"Hmm, perhaps we should have started with a doll."
        [/message]

        [message]
            speaker=student
            message= _"Should I retreat?"
        [/message]

        [message]
            speaker=Delfador
            message= _"Good idea!"
        [/message]

        {GENDER (
            [message]
                speaker=narrator
                caption= _"Crowns"
                image=wesnoth-icon.png
                message= _"The tiny metal crown above your leader (Konrad) means you will lose the game if he is killed. A similar crown above Delfador indicates you will also lose the game if he dies."
            [/message]
        ) (
            [message]
                speaker=narrator
                caption= _"Crowns"
                image=wesnoth-icon.png
                message= _"The tiny metal crown above your leader (Li’sar) means you will lose the game if she is killed. A similar crown above Delfador indicates you will also lose the game if he dies."
            [/message]
        )}

        {MOVE_UNIT (id=Delfador) 14 8}

        {MODIFY_UNIT (id=Delfador) facing nw}

        [message]
            speaker=Delfador
            message= _"Unfortunately, you’ve used up your turn attacking the quintain. The quintain now gets to attack."
        [/message]

        [message]
            speaker=student
            message= _"The <i>dummy</i> gets a turn?"
        [/message]

        [message]
            speaker=Delfador
            message= _"Yes. It’s a magical quintain! It gets 5 chances to hit you for 3 damage each. If it hits every time, you’ll drop from $student_hp to $($student_hp-15) hitpoints. Brace yourself!"
        [/message]

        [allow_end_turn][/allow_end_turn]

        {PRINT (_"Click on the <b>End Turn</b> button in the bottom right of the screen to end your turn")}
    [/event]

    # TURN 2: lesson in healing
    # There is a 1 in 170,000 chance that the quintain will miss on all
    # 10 attacks. Ignoring that.
    [event]
        name=turn 2

        [disallow_end_turn][/disallow_end_turn]

        {CLEAR_PRINT}

        [message]
            speaker=student
            message= _"Ouch! I need to heal! Only $student_hp hitpoints left!"
        [/message]

        [message]
            speaker=Delfador
            message= _"There is a village on the other side of the river. Visiting villages is a good idea, and ending your turn in one will heal you. To the village!"
        [/message]

        {GENDER (
            {PRINT (_"Move Konrad to the nearest village")}
        ) (
            {PRINT (_"Move Li’sar to the nearest village")}
        )}

        [event]
            name=moveto
            [filter]
                side=1
                x,y=11,7
            [/filter]

            {CLEAR_PRINT}

            [message]
                speaker=narrator
                caption= _"Villages"
                image=wesnoth-icon.png
                # We could say 'It now flies your colors...'. Maybe too subtle for a basic tutorial?
                message= _"You have captured a village! It now flies your flag and has been added to your total village count (the house icon at the top of the screen shows how many villages you currently control). Villages provide the gold needed to recruit units. Each turn, you gain two gold plus one for every village you own."
            [/message]

            [allow_end_turn][/allow_end_turn]

            {PRINT (_"End your turn")}
        [/event]
    [/event]

    # TURN 3: lesson in recruiting
    # Use a refresh event so dialog happens post-healing
    [event]
        name=turn 3 refresh

        [disallow_end_turn][/disallow_end_turn]

        {CLEAR_PRINT}

        [message]
            speaker=Delfador
            message= _"Since you started your turn on a village, you regained some health! Villages heal units 8 hitpoints per turn, or enough to top off their health, whichever is less. In your case, you regained $student_hp_heal_amount hitpoints."
        [/message]

        [message]
            speaker=Delfador
            message= _" Now, it’s time to summon some help against that quintain."
        [/message]

        [message]
            speaker=student
            message= _"I’ll recruit some elves!"
        [/message]

        [message]
            speaker=Delfador
            message= _"A splendid idea! It’s probably best not to attempt attacking the quintain this turn. Instead, you could return to the keep and recruit two units; you have plenty of gold for that."
        [/message]

        {GENDER (
            {PRINT (_"Move Konrad to the keep")}
        ) (
            {PRINT (_"Move Li’sar to the keep")}
        )}

        [event]
            name=moveto
            [filter]
                x,y=9,6
            [/filter]

            {CLEAR_PRINT}

            [set_recruit]
                recruit=Elvish Fighter
                side=1
            [/set_recruit]

            [message]
                speaker=narrator
                caption= _"Recruiting"
                image=wesnoth-icon.png
                message= _"Whenever you’re on a <i>keep</i>, you can <i>recruit</i> into the castle tiles around it by right-clicking and selecting <b>Recruit</b>. This time you will only be given one type of unit to choose: the Elvish Fighter."
            [/message]

            {PRINT (_"Recruit two Elvish Fighters")}
        [/event]

        [event]
            name=prerecruit
            first_time_only=no

            # zookeeper suggested we eliminate traits by killing the recruit and replacing it
            [kill]
                x,y=$x1,$y1
            [/kill]

            # Each one needs a unique description for next level.
            {VARIABLE_OP description_num add 1}

            {NOTRAIT_UNIT 1 "Elvish Fighter" $x1 $y1}
            [+unit]
                role="Recruit $description_num"
                moves=0
                generate_name=yes
            [/unit]
        [/event]

        [event]
            name=recruit
            first_time_only=no
            [filter]
                side=1
            [/filter]
            [filter_condition]
                [have_unit]
                    role="Recruit 2"
                [/have_unit]
            [/filter_condition]

            {CLEAR_PRINT}

            [message]
                speaker=narrator
                caption= _"New Recruits"
                image=wesnoth-icon.png
                message= _"New units cannot act in the turn they appear; you will gain control of them next turn.
After this dialog, you can move the mouse over a unit to see a summary of its abilities and stats on the right of the screen."
            [/message]

            [allow_end_turn][/allow_end_turn]

            {PRINT (_"End your turn")}
        [/event]

        # Clean up hp tracking. We no longer need it after this point
        {CLEAR_VARIABLE student_hp,student_hp_heal_amount}

        [remove_event]
            id=hp_stat_tracking
        [/remove_event]
    [/event]

    # TURN 4: enemy healing and attacking
    [event]
        name=turn 4

        [disallow_end_turn][/disallow_end_turn]

        {CLEAR_PRINT}

        [message]
            speaker=student
            message= _"Hey, the quintain just healed 2 hitpoints! I’d better attack it at once!"
        [/message]

        [message]
            speaker=Delfador
            message= _"Yes, if a unit doesn’t do anything for a turn, it will slowly heal."
        [/message]

        [message]
            speaker=Delfador
            message= _"Before you send your fighters against the quintain, you should know they have two kinds of attack..."
        [/message]

        [message]
            speaker=student
            message= _"I’ll tell them to use the one that does the most damage!"
        [/message]

        [message]
            speaker=Delfador
            message= _"And which would that be? The sword (5–4) or the bow (3–3)? I suppose you’ll find out..."
        [/message]

        {PRINT (_"Attack the quintain with your fighters")}

        {VARIABLE trying_to_be_a_wiseguy yes}

        [event]
            name=select
            first_time_only=no
            [filter]
                id=student
            [/filter]
            [filter_condition]
                [variable]
                    name=trying_to_be_a_wiseguy
                    boolean_equals=yes
                [/variable]
            [/filter_condition]

            [message]
                speaker=Delfador
                message= _"You wouldn’t do anything stupid like charging that quintain yourself again, now would you? Use the fighters you recruited first; they’ll be a lot of help."
            [/message]
        [/event]

        [event]
            name=attack
            [filter]
                type=Elvish Fighter
            [/filter]

            {VARIABLE trying_to_be_a_wiseguy no}

            {CLEAR_PRINT}

            # After this, we no longer need to restrict turn endings
            [allow_end_turn][/allow_end_turn]
        [/event]

        [event]
            name=attack_end
            [filter]
                type=Elvish Fighter
            [/filter]
            [filter_attack]
                name=sword
            [/filter_attack]

            [message]
                speaker=Delfador
                message= _"Your elf used a sword (5–4; or 5 damage, 4 attacks), which is a <i>melee</i> attack. The quintain defended with its melee attack (3–5). The ranged attack would have been safer."
            [/message]
        [/event]

        [event]
            name=attack_end
            [filter_attack]
                name=bow
            [/filter_attack]

            [message]
                speaker=Delfador
                message= _"Your elf used a bow, which is a <i>ranged</i> attack (3–3; or 3 damage, 3 attacks). The quintain has no ranged attack, only a melee attack, so it could not defend itself."
            [/message]
        [/event]
    [/event]

    # TURN 5 onwards: advice
    # Only fire this particular event if we didn't kill the quintain last turn
    # If we didn't, Delf is still around
    [event]
        name=turn 5

        {CLEAR_PRINT}

        [message]
            speaker=Delfador
            message= _"Keep attacking with both elves until the quintain is finished!"
            [show_if]
                [have_unit]
                    id=Delfador
                [/have_unit]
            [/show_if]
        [/message]
    [/event]

    # TURN 6: recruit more guys
    [event]
        name=turn 6

        [message]
            speaker=Delfador
            message= _"Maybe you should recruit another elf?"
            [show_if]
                [have_unit]
                    id=Delfador
                [/have_unit]
            [/show_if]
        [/message]

        [message]
            speaker=narrator
            caption= _"Unit Descriptions"
            image=wesnoth-icon.png
            message= _"You can right click on a unit to see a detailed <b>Unit Description</b>."
        [/message]
    [/event]

    # TURN 7: protect your troops
    [event]
        name=turn 7

        [message]
            speaker=narrator
            caption= _"Protect Your Troops"
            image=wesnoth-icon.png
            message= _"Remember to pull back wounded units into villages and recruit more if needed. Take special care of units with the highest <i>experience points (XP)</i> so they can gain levels and become more powerful."
        [/message]
    [/event]

    # TURN 8: support
    [event]
        name=turn 8

        [message]
            speaker=narrator
            caption= _"Support"
            image=wesnoth-icon.png
            message= _"Each village you control will <i>support</i> one unit for free. After that, each unit costs you one gold per turn."
        [/message]
    [/event]

    # TURN 9: advancement
    [event]
        name=turn 9

        [message]
            speaker=narrator
            caption= _"Advancement"
            image=wesnoth-icon.png
            message= _"When a unit gains enough experience points (the <i>experience bar</i>, if present, is on the <b>right</b> of the <i>hitpoints bar</i>), it will go up a level. Elvish Fighters have two advancement options, and you will be able to choose which one you want. However, second level units cost twice as much to support as first level units."
        [/message]
    [/event]

    # TURN 10: defenses
    [event]
        name=turn 10

        [message]
            speaker=narrator
            caption= _"Defenses"
            image=wesnoth-icon.png
            # wmllint: local spelling quintains
            message= _"Whenever one of your units is selected, you’ll see varying percentages as you move the mouse over the map. The higher the percentage, the more <i>defense</i> that unit has in that kind of terrain. For example, most units have good defenses in castles and villages but poor defenses in rivers. However, these quintains use a <i>magical</i> attack, which always has a 70% chance of hitting no matter what terrain its target occupies."
        [/message]
    [/event]

    # Experience tracking needed in scenario 2 code
    # Give them roles of 'Veteran' as well or instead? Lets you track 0XP units cleanly.
    [event]
        name=advance
        first_time_only=no

        {VARIABLE_OP unit.variables.previous_xp add $unit.max_experience}

        [unstore_unit]
            variable=unit
            advance=false
        [/unstore_unit]
    [/event]

    [event]
        name=die
        [filter]
            id=student
        [/filter]

        [endlevel]
            result=defeat
        [/endlevel]
    [/event]

    # Death of the first quintain
    [event]
        name=die
        first_time_only=yes
        [filter]
            type=Quintain
        [/filter]

        {CLEAR_PRINT}

        [message]
            speaker=second_unit
            message= _"The quintain is destroyed, and I have gained more experience!"
        [/message]

        {GENDER (
            [message]
                speaker=Delfador
                message= _"Yes, you gain experience through battle, especially by killing an opponent. Gain enough experience and you’ll become more powerful.
Now, Konrad, I will leave you with more dummies to practice on! After that, we have real work to do..."
            [/message]
        ) (
            [message]
                speaker=Delfador
                message= _"Yes, you gain experience through battle, especially by killing an opponent. Gain enough experience and you’ll become more powerful.
Now, Li’sar, I will leave you with more dummies to practice on! After that, we have real work to do..."
            [/message]
        )}

        [scroll_to_unit]
            id=Delfador
        [/scroll_to_unit]

        [animate_unit]
            [filter]
                id=Delfador
            [/filter]
            flag=summon_quintain_raise_staff
        [/animate_unit]

        [sound]
            name=lightning.ogg
        [/sound]

        [color_adjust]
            red=100
            green=100
            blue=100
        [/color_adjust]

        [animate_unit]
            [filter]
                id=Delfador
            [/filter]
            flag=summon_quintain_lower_staff
        [/animate_unit]

        [color_adjust]
            red=0
            green=0
            blue=0
        [/color_adjust]

        [unit]
            id=Quintain1
            type=Quintain
            ai_special="guardian"
            x,y=16,10
            side=2
        [/unit]

        [unit]
            id=Quintain2
            type=Quintain
            ai_special="guardian"
            x,y=13,11
            side=2
        [/unit]

        [unit]
            id=Quintain3
            type=Quintain
            ai_special="guardian"
            x,y=9,11
            side=2
        [/unit]

        {MOVE_UNIT (id=Delfador) (12,8,8) (7,9,11)}

        [scroll_to_unit]
            type=Quintain
        [/scroll_to_unit]

        [kill]
            id=Delfador
        [/kill]

        [message]
            speaker=narrator
            caption= _"Note"
            message= _"These dummies only attack if you are a single tile away. With care, you should be able to kill them one at a time."
        [/message]

        [event]
            name=new turn
            first_time_only=yes

            [set_menu_item]
                description= _ "End Scenario"
                id=skip_item
                [command]
                    [endlevel]
                        result=victory
                        carryover_report=no
                        carryover_add=yes
                        carryover_percentage=0
                    [/endlevel]
                [/command]
            [/set_menu_item]

            [message]
                speaker=narrator
                message= _"Do you want to keep practicing? You can end this scenario at any time by using the <b>End Scenario</b> item in the context menu."
                [option]
                    message= _"Yes, I’m still figuring it out."
                [/option]
                [option]
                    message= _"No, I think I’ve got it."
                    [command]
                        [endlevel]
                            result=victory
                            carryover_report=no
                            carryover_add=yes
                            carryover_percentage=0
                        [/endlevel]
                    [/command]
                [/option]
            [/message]
        [/event]
    [/event]

    [event]
        name=time over

        [if]
            [have_unit]
                id=quintain
            [/have_unit]
            [then]
                [endlevel]
                    result=defeat
                [/endlevel]
            [/then]
            [else]
                [endlevel]
                    result=victory
                    carryover_report=no
                    carryover_add=yes
                    carryover_percentage=0
                [/endlevel]
            [/else]
        [/if]
    [/event]

    [event]
        name=victory
        [message]
            speaker="narrator"
            caption= _"Victory"
            image=wesnoth-icon.png
            message= _"After your victory notice, the map will be grayed out to indicate that the scenario is over, but you will still be able to examine the final positions and state of your troops and any surviving enemies. This is called <i>linger mode</i>. When you’re finished, click the <b>End Scenario</b> button to go on to the next scenario in the campaign."
        [/message]

        [clear_menu_item]
            id=skip_item
        [/clear_menu_item]

        {CLEAR_VARIABLE trying_to_be_a_wiseguy,description_num}
    [/event]

    [event]
        name=defeat

        {CLEAR_PRINT}
    [/event]
[/tutorial]