Skip to content

Commit

Permalink
Add docs about crowns and ellipses
Browse files Browse the repository at this point in the history
The image added here is a grass background to draw units on via Image Path
Functions. For the documentation, a square image looks better than a hexagon
that has black borders.
  • Loading branch information
stevecotton committed Oct 26, 2020
1 parent d741365 commit b523297
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 4 deletions.
1 change: 1 addition & 0 deletions changelog.md
Expand Up @@ -18,6 +18,7 @@
### Miscellaneous and Bug Fixes
* Fixed a rare issue on Windows that could result in wesnoth.exe sticking around waiting for console input after encountering an error despite not being launched with the `--wconsole` option.
* Fixed precise log timestamps missing a space between the timestamp and the log severity label.
* Improve the in-game help's topic about orbs, add crowns and ellipses.

## Version 1.15.6
### Add-ons client
Expand Down
62 changes: 58 additions & 4 deletions data/core/help.cfg
Expand Up @@ -21,7 +21,7 @@
[section]
id=gameplay
title= _ "Gameplay"
topics=..gameplay,victory_and_defeat,recruit_and_recall,income_and_upkeep,hitpoints,advancement,movement,shroud_and_fog,combat,damage_types_and_resistance,orbs,time_of_day,healing,saveload,whylost,wrap_up
topics=..gameplay,victory_and_defeat,recruit_and_recall,income_and_upkeep,hitpoints,advancement,movement,shroud_and_fog,combat,damage_types_and_resistance,orbs,crowns,time_of_day,healing,saveload,whylost,wrap_up
[/section]

[section]
Expand Down Expand Up @@ -379,8 +379,8 @@ If a strike is determined to hit, it will always do at least 1 point of damage.
# wmllint: markcheck off
[topic]
id=orbs
title= _ "Orbs"
text= _ "There are colored indicators above the energy bars of some units, consisting of a colored orb and (for leaders) a crown." + "
title= _ "Orbs and ellipses"
text= _ "There are colored indicators above the energy bars of some units, consisting of a colored orb (and sometimes a <ref>dst='crowns' text='crown'</ref>)." + "
<img>src=help/orb-green.png align=here</img> <img>src=help/orb-yellow.png align=here</img> <img>src=help/orb-red.png align=here</img> <img>src=help/orb-blue.png align=here</img> <img>src=help/orb-none.png align=here</img>
Expand All @@ -390,7 +390,61 @@ If a strike is determined to hit, it will always do at least 1 point of damage.
" + _ "• <bold>text='Red'</bold> if it can no longer move or attack.
• Red is also used after the ‘end unit turn’ command, and when a unit is in the middle of a multi-turn move (has been told to move further than it can in the current turn)." + "
" + _ "• <bold>text='Blue'</bold> for allied units. During the ally’s own turn, their units will be shown with the green/yellow/red colors; however their moves, and the corresponding orb changes, are delayed as explained in <ref>dst='shroud_and_fog' text='Shroud and Fog of War'</ref>." + "
" + _ "• Enemy units normally don’t have orbs, however these can be enabled in the advanced preference “Customize orb colors”."
" + _ "• Enemy units normally don’t have orbs, however these can be enabled in the advanced preference “Customize orb colors”." + "
" + _ "<header>text='Ellipses'</header>" + "
" +
_"A team-colored shape is drawn on the ground under each unit. This is called the “ellipse”, although some units’ ellipses are not elliptical." + "
" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-top.png)~BLIT(misc/ellipse-bottom.png)~BLIT(units/human-loyalists/spearman.png~TC(1, magenta))'</img>" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-leader-top.png)~BLIT(misc/ellipse-leader-bottom.png)~BLIT(units/human-loyalists/lieutenant.png~TC(1, magenta))'</img>" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-hero-top.png)~BLIT(misc/ellipse-hero-bottom.png)~BLIT(units/human-loyalists/lieutenant.png~TC(1, magenta))'</img>" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-nozoc-top.png)~BLIT(misc/ellipse-nozoc-bottom.png)~BLIT(units/human-peasants/peasant.png~TC(1, magenta))'</img>" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-leader-nozoc-top.png)~BLIT(misc/ellipse-leader-nozoc-bottom.png)~BLIT(units/human-peasants/peasant.png~TC(1, magenta))'</img>" + "
" +
#po: The help page has a set of images above this paragraph, in the same order as the bullet points
_ "• Most units have a circular ellipse.
• Units that can recruit have a seven-pointed star.
• <ref>dst='crowns' text='Hero units'</ref> have a smaller variant of the seven-pointed star, these units can’t recruit.
• Units without a <ref>dst='movement' text='zone of control'</ref> have a broken version of the shape.
• Some campaigns start with a level zero leader. Able to recruit but lacking a ZoC, these units have a broken version of the seven-pointed star."
[/topic]
# wmllint: markcheck on

# wmllint: markcheck off
[topic]
id=crowns
title= _ "Crowns and loyal markers"
text=_ "Some units have an additional marker superimposed on their <ref>dst='orbs' text='orb'</ref>, and a corresponding shape to their <ref>dst='orbs' text='ellipses'</ref>:" + "
" +
"<img>src='help/empty-square.png~CROP(0,0,72,36)~BLIT(misc/leader-crown.png~CROP(4,0,36,18)~XBRZ(2))'</img>" +
"<img>src='help/empty-square.png~CROP(0,0,72,36)~BLIT(misc/hero-icon.png~CROP(4,0,36,18)~XBRZ(2))'</img>" +
"<img>src='help/empty-square.png~CROP(0,0,72,36)~BLIT(misc/leader-expendable.png~CROP(4,0,36,18)~XBRZ(2))'</img>" +
"<img>src='help/empty-square.png~CROP(0,0,72,36)~BLIT(misc/loyal-icon.png~CROP(4,0,36,18)~XBRZ(2))'</img>" + "
" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-leader-top.png)~BLIT(misc/ellipse-leader-bottom.png)~BLIT(units/orcs/leader.png~TC(1, magenta))~BLIT(misc/leader-crown.png)'</img>" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-hero-top.png)~BLIT(misc/ellipse-hero-bottom.png)~BLIT(units/dunefolk/herbalist/alchemist.png~TC(1, magenta))~BLIT(misc/hero-icon.png)'</img>" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-leader-top.png)~BLIT(misc/ellipse-leader-bottom.png)~BLIT(units/human-magi/white-mage.png~TC(1, magenta))~BLIT(misc/leader-expendable.png)'</img>" +
"<img>src='help/empty-square.png~BLIT(misc/ellipse-top.png)~BLIT(misc/ellipse-bottom.png)~BLIT(units/human-loyalists/spearman.png~TC(1, magenta))~BLIT(misc/loyal-icon.png)'</img>" + "
" +
#po: The help page has a set of images above this paragraph, in the same order as the first set of bullet points, showing what the "loyal icon" is and the difference between "silver" and "blueish-silver".
_ "• Leaders are shown with a <bold>text='gold crown'</bold>.
• Heroes have a <bold>text='blueish-silver crown'</bold>.
• Expendable leaders are shown with a <bold>text='silver crown'</bold>.
• <ref>dst='traits_loyal' text='Loyal units'</ref> have the <bold>text='loyal icon'</bold>.
Of these categories, only leaders are built into the basic game rules. The others are found in campaigns, and are characters that form part of the narration. The exact rules for them are set by their campaign, which might deviate from these standard expectations about them:
• The death of any hero leads to immediate defeat.
• The death of an expendable leader doesn’t lead to immediate defeat, even though they can recruit.
• All of these units have the main advantage of the loyal trait, that they cost no upkeep.
• Losing any of these units causes a disadvantage for the remainder of the campaign, assuming it doesn’t end immediately.
• These units will never occur as random recruits."
[/topic]
# wmllint: markcheck on

Expand Down
Binary file added data/core/images/help/empty-square.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b523297

Please sign in to comment.