WML for Complete Beginners: Chapter 4 - Revision history

Celtic Minstrel: Use syntax highlighting

2023-01-29T20:09:54Z

Use syntax highlighting

Celtic Minstrel: Nicer index and navigation

2023-01-29T19:02:00Z

Nicer index and navigation

← Older revision		Revision as of 19:02, 29 January 2023
Line 1:		Line 1:
			{{Translations}}<div style="float:right">{{:WML for Complete Beginners}}</div>

	==Chapter 4: Creating Your First Scenario==		==Chapter 4: Creating Your First Scenario==

Line 235:		Line 237:
	[/scenario]		[/scenario]

	Now we are just one final step away from finishing it, and finally playing it at last. The next step in creating your first scenario is to add the events which trigger in-game. To learn how to create events, continue to ~~[[WML for Complete Beginners: Chapter 5]]~~.		Now we are just one final step away from finishing it, and finally playing it at last. The next step in creating your first scenario is to add the events which trigger in-game. To learn how to create events, continue to the next chapter.

	~~Or, head back to [[WML for Complete Beginners: Chapter 3]]~~

	~~Return to Main Index~~:		{{Navigation\|[[WML for Complete Beginners: Chapter 3\|'''Chapter 3'''<br>The _main.cfg]]\|[[WML for Complete Beginners: Chapter 5\|'''Chapter 5'''<br>Events]]}}
	[[WML for Complete Beginners]]

	[[Category:WML_for_Complete_Beginners]]		[[Category:WML_for_Complete_Beginners]]

Octalot: /* The Toplevel Tagset and Attributes */ Suggest map_file instead of map_data

2020-09-07T20:28:01Z

The Toplevel Tagset and Attributes: Suggest map_file instead of map_data

← Older revision		Revision as of 20:28, 7 September 2020
Line 108:		Line 108:


	*'''The "map_data" Key		*'''The "map_data" or "map_file" Key

	:~~For this~~ key, we are going to assign the value "{~add-ons/my_first_campaign/maps/my_first_map.map}". Map filepaths must always be within surrounded by double quotes, otherwise error messages will occur. Now it should look like this:		:In Wesnoth 1.12, we use the "map_data" key, and are going to assign the value "{~add-ons/my_first_campaign/maps/my_first_map.map}". Map filepaths must always be within surrounded by double quotes, otherwise error messages will occur. Now it should look like this:
	map_data="{~add-ons/my_first_campaign/maps/my_first_map.map}"		map_data="{~add-ons/my_first_campaign/maps/my_first_map.map}"

			:{{DevFeature1.15\|3}} we can use either "map_data" or the new "map_file" key. If you've added [[WML_for_Complete_Beginners:_Chapter_3#The_Binary_Path\|the previous chapter's binary_path]], the following line will automatically look in the ~add-ons/my_first_campaign/maps/ directory.
			map_file=my_first_map.map

			The 1.12 method will still work in later versions, but the 1.15.3 method is preferred.

	*'''The "turns" Key'''		*'''The "turns" Key'''

Greeneyelink: /* Creating the Scenario Map */

2018-06-18T21:10:19Z

Creating the Scenario Map

← Older revision		Revision as of 21:10, 18 June 2018
Line 27:		Line 27:
	In the Wesnoth maps there are two layers. The "base" layer and the "overlay" layer. Base is the terrain that is below, and the overlay is the plants, buildings, bridges, etc. on it. To help you to understand better: the same forest can stand on grassland, hills, dry hills, mountains, even sand. And the same hillside can foster deciduous forests, mixed forests, summer forests, even desert forests. Something similar goes for buildings: the same bridge can span over shallow water, tropical water, swamp, even grassland, should the river be dried up.		In the Wesnoth maps there are two layers. The "base" layer and the "overlay" layer. Base is the terrain that is below, and the overlay is the plants, buildings, bridges, etc. on it. To help you to understand better: the same forest can stand on grassland, hills, dry hills, mountains, even sand. And the same hillside can foster deciduous forests, mixed forests, summer forests, even desert forests. Something similar goes for buildings: the same bridge can span over shallow water, tropical water, swamp, even grassland, should the river be dried up.

	How to draw that on the map? Easy: with the Shift key. Choose a forest, building, etc., and put it down while holding the Shift key. As you shall see, the stuff you have chosen shall be put on top of the existing base terrain, leaving it unchanged. Or try the other way around: ~~Choose~~ a terrain, and put it under an existing bridge, forest, etc., with the Shift key pressed and held down. Experiment a little, you shall get the hang if it pretty quick.		How to draw that on the map? Easy: with the Shift key. Choose a forest, building, etc., and put it down while holding the Shift key. As you shall see, the stuff you have chosen shall be put on top of the existing base terrain, leaving it unchanged. Or try the other way around: choose a terrain, and put it under an existing bridge, forest, etc., with the Shift key pressed and held down. Experiment a little, you shall get the hang if it pretty quick.

	When you judge your environment be finished, let's add a castle for the leader of the player's side to recruit from in the first scenario. Click on the "castle" category button. Then paint your castle the same way you paint any other terrain.		When you judge your environment be finished, let's add a castle for the leader of the player's side to recruit from in the first scenario. Click on the "castle" category button. Then paint your castle the same way you paint any other terrain.

Greeneyelink: /* Creating the Scenario Map */

2018-06-18T21:07:47Z

Creating the Scenario Map

← Older revision		Revision as of 21:07, 18 June 2018
Line 21:		Line 21:
	(screenshot)		(screenshot)

	First, let's add some terrain, for example, hills. Click on the "rough" category button. You should see all available rough terrain types, namely hills, mountains, impassable high mountains and the like. Left click one to assign it to the left mouse button. Now the bottom of the map area shows your chosen terrain. You can do it for the right button too, so you always have 2 types of terrain ready. Go to the map area. Click one hex, or click and hold the left mouse button and swipe the mouse through several hexes. Your ~~castle~~ is now ~~built~~, using the chosen type from the palette. If you accidentally clicked a hex where you don’t want your chosen terrain to expand to, just choose any other type of terrain (grassland, forest, swamp, etc.) and paint it over. You can add grassland, waters, roads, deserts the same way. If you already have a certain terrain type applied on your map, you can assign it to the mouse buttons by Ctrl-clicking on them, instead of finding them again on the palette.		First, let's add some terrain, for example, hills. Click on the "rough" category button. You should see all available rough terrain types, namely hills, mountains, impassable high mountains and the like. Left click one to assign it to the left mouse button. Now the bottom of the map area shows your chosen terrain. You can do it for the right button too, so you always have 2 types of terrain ready. Go to the map area. Click one hex, or click and hold the left mouse button and swipe the mouse through several hexes. Your terrain is now painted, using the chosen type from the palette. If you accidentally clicked a hex where you don’t want your chosen terrain to expand to, just choose any other type of terrain (grassland, forest, swamp, etc.) and paint it over. You can add grassland, waters, roads, deserts the same way. If you already have a certain terrain type applied on your map, you can assign it to the mouse buttons by Ctrl-clicking on them, instead of finding them again on the palette.

	Now let's add some forest to our newly placed hills. Choose the "forest" category button, and then for example "Summer Deciduous Forest". Now click on the hex you want to put your hillside forest to. The forest is inserted, but the hillside is gone! Now the forest stands on grassland. This brings us to one important aspect: the layers of the map.		Now let's add some forest to our newly placed hills. Choose the "forest" category button, and then for example "Summer Deciduous Forest". Now click on the hex you want to put your hillside forest to. The forest is inserted, but the hillside is gone! Now the forest stands on grassland. This brings us to one important aspect: the layers of the map.

Greeneyelink: /* Creating the Scenario Map */

2018-06-18T20:50:37Z

Creating the Scenario Map

← Older revision		Revision as of 20:50, 18 June 2018
Line 21:		Line 21:
	(screenshot)		(screenshot)

	First, let's add ~~a castle~~ for the ~~leader~~ of the ~~player's side~~ to ~~recruit~~ from in the ~~first scenario~~. ~~Click~~ on the ~~"castle" category button~~.		First, let's add some terrain, for example, hills. Click on the "rough" category button. You should see all available rough terrain types, namely hills, mountains, impassable high mountains and the like. Left click one to assign it to the left mouse button. Now the bottom of the map area shows your chosen terrain. You can do it for the right button too, so you always have 2 types of terrain ready. Go to the map area. Click one hex, or click and hold the left mouse button and swipe the mouse through several hexes. Your castle is now built, using the chosen type from the palette. If you accidentally clicked a hex where you don’t want your chosen terrain to expand to, just choose any other type of terrain (grassland, forest, swamp, etc.) and paint it over. You can add grassland, waters, roads, deserts the same way. If you already have a certain terrain type applied on your map, you can assign it to the mouse buttons by Ctrl-clicking on them, instead of finding them again on the palette.

	~~(screenshot~~ of the ~~castle~~ terrain ~~category button)~~		Now let's add some forest to our newly placed hills. Choose the "forest" category button, and then for example "Summer Deciduous Forest". Now click on the hex you want to put your hillside forest to. The forest is inserted, but the hillside is gone! Now the forest stands on grassland. This brings us to one important aspect: the layers of the map.

			In the Wesnoth maps there are two layers. The "base" layer and the "overlay" layer. Base is the terrain that is below, and the overlay is the plants, buildings, bridges, etc. on it. To help you to understand better: the same forest can stand on grassland, hills, dry hills, mountains, even sand. And the same hillside can foster deciduous forests, mixed forests, summer forests, even desert forests. Something similar goes for buildings: the same bridge can span over shallow water, tropical water, swamp, even grassland, should the river be dried up.

			How to draw that on the map? Easy: with the Shift key. Choose a forest, building, etc., and put it down while holding the Shift key. As you shall see, the stuff you have chosen shall be put on top of the existing base terrain, leaving it unchanged. Or try the other way around: Choose a terrain, and put it under an existing bridge, forest, etc., with the Shift key pressed and held down. Experiment a little, you shall get the hang if it pretty quick.

	~~You should see all available~~ castle ~~types~~. ~~Left click one to assign it to~~ the ~~left mouse~~ button. ~~Now the bottom of the map area shows~~ your ~~chosen terrain. You can do it for~~ the ~~right button too, so~~ you ~~always have 2 types of~~ terrain ~~ready~~.		When you judge your environment be finished, let's add a castle for the leader of the player's side to recruit from in the first scenario. Click on the "castle" category button. Then paint your castle the same way you paint any other terrain.

	~~Go to the map area. Click one hex, or click and hold the left mouse button and swipe the mouse through several hexes. Your castle is now built, using~~ the ~~chosen type from the palette. If you accidentally clicked a hex where you don’t want your~~ castle ~~to expand to, just choose any other type of~~ terrain ~~(grassland, forest, swamp, etc.~~) ~~and paint it over.~~		(screenshot of the castle terrain category button)
	~~If you already have a certain terrain type applied on your map, you can assign it to the mouse buttons by Ctrl-clicking on them, instead of finding them again on the palette.~~

	Don’t forget to add a keep to your castle. That’s where your leader shall be positioned at the start of the scenario, and that’s where he (or she) can recruit his/her army from.		Don’t forget to add a keep to your castle. That’s where your leader shall be positioned at the start of the scenario, and that’s where he (or she) can recruit his/her army from.
Line 34:		Line 37:
	Draw a castle with a keep for the opposite party too. (Unless of course if you want to build a scenario without an enemy.)		Draw a castle with a keep for the opposite party too. (Unless of course if you want to build a scenario without an enemy.)

	~~Draw the natural terrain (hills, river, etc.)~~ for ~~the rest of the map.~~ You can place villages the same way as any other type of terrain.		As for villages: You can place villages the same way as any other type of terrain. Assigning the villages to sides in another matter, we shall discuss the topic of assigning the villages to either side in a later chapter.
	We shall discuss the topic of assigning the villages to either side in a later chapter.

	We are almost done with the map, but in order to use it, we have to assign our leaders to the keeps. This is done by using the Starting Positions Tool.		We are almost done with the map, but in order to use it, we have to assign our leaders to the keeps. This is done by using the Starting Positions Tool.

Greeneyelink: /* Defining Sides */

2018-04-19T20:34:26Z

Defining Sides

← Older revision		Revision as of 20:34, 19 April 2018
Line 229:		Line 229:
	[/scenario]		[/scenario]

	The next step in creating your first scenario is to add the events which trigger in-game. To learn how to create events, continue to [[WML for Complete Beginners: Chapter 5]].		Now we are just one final step away from finishing it, and finally playing it at last. The next step in creating your first scenario is to add the events which trigger in-game. To learn how to create events, continue to [[WML for Complete Beginners: Chapter 5]].

	Or, head back to [[WML for Complete Beginners: Chapter 3]]		Or, head back to [[WML for Complete Beginners: Chapter 3]]

Greeneyelink: /* Defining Sides */

2018-04-19T20:32:08Z

Defining Sides

← Older revision		Revision as of 20:32, 19 April 2018
Line 134:		Line 134:

	In any scenario, you will always need at least one side (the player's), and usually at least one other side as well. For this scenario, we need to define two sides: the player's side and the enemy's side.		In any scenario, you will always need at least one side (the player's), and usually at least one other side as well. For this scenario, we need to define two sides: the player's side and the enemy's side.

			Haven't we just done it on the map? Yes, but we shall need to define those sides in detail here in the scenario's configuration file too. Player 1 and 2 on the map shall be called Side 1 and 2 here respectively.

	Let's start with the player's side. In order to define a side, we need to include the [side] tagset as a child of the [scenario] tagset. All the keys we add to define a side go inside this [side] tagset.		Let's start with the player's side. In order to define a side, we need to include the [side] tagset as a child of the [scenario] tagset. All the keys we add to define a side go inside this [side] tagset.

Greeneyelink: /* Creating the Scenario Map */

2018-04-19T20:23:46Z

Creating the Scenario Map

← Older revision		Revision as of 20:23, 19 April 2018
Line 21:		Line 21:
	(screenshot)		(screenshot)

	First, let's add a castle for the leader of the player's side to recruit from in the first scenario. Click on the "castle" ~~terrain~~ category button.		First, let's add a castle for the leader of the player's side to recruit from in the first scenario. Click on the "castle" category button.

	(screenshot of the castle terrain category button)		(screenshot of the castle terrain category button)

	You should see all available castle ~~terrain~~ types. Left click one to assign it to the left mouse button. Now the bottom of the map area shows your chosen terrain. You can do it for the right button too, to always have 2 types of terrain ready.		You should see all available castle types. Left click one to assign it to the left mouse button. Now the bottom of the map area shows your chosen terrain. You can do it for the right button too, so you always have 2 types of terrain ready.

	Go to the map area. Click one hex, or click and hold the left mouse button and swipe the mouse through several hexes. Your castle is now built, using the chosen type from the palette. If you clicked a hex where you don’t want castle ~~terrain~~, just choose any other type of terrain (grassland, forest, swamp, etc.) and paint it over.		Go to the map area. Click one hex, or click and hold the left mouse button and swipe the mouse through several hexes. Your castle is now built, using the chosen type from the palette. If you accidentally clicked a hex where you don’t want your castle to expand to, just choose any other type of terrain (grassland, forest, swamp, etc.) and paint it over.
	If you already have a certain terrain type on your map, you can assign it to the mouse buttons by Ctrl-clicking on them, instead of finding them again on the palette.		If you already have a certain terrain type applied on your map, you can assign it to the mouse buttons by Ctrl-clicking on them, instead of finding them again on the palette.

	Don’t forget to add a keep to your castle. That’s where your leader shall be positioned at the start of the scenario, and that’s where he (or she) can recruit his/her army from.		Don’t forget to add a keep to your castle. That’s where your leader shall be positioned at the start of the scenario, and that’s where he (or she) can recruit his/her army from.
Line 43:		Line 43:
	Click on the flag, then choose Player 1 (usually the human player) or Player 2 (usually the AI). Now click on the preferred keep. That's it, now you have your leader assigned to the castle. A label with the player name should also appear.		Click on the flag, then choose Player 1 (usually the human player) or Player 2 (usually the AI). Now click on the preferred keep. That's it, now you have your leader assigned to the castle. A label with the player name should also appear.

	Finally, save your new map. ~~Remember~~ the ~~exact path~~ and ~~file name, as we shall need~~ it later on.		Finally, save your new map. You may save it to the Editor default location (data folder/editor/maps) and copy it over later to the data folder. Instead let us save it directly where our scenario needs it, i.e. the scenario’s map location (add-ons/my_first_campaign/maps/my_first_map.map).

	===Creating the Scenario .cfg File===		===Creating the Scenario .cfg File===

Greeneyelink: /* Creating the Scenario Map */

2018-04-17T20:56:39Z

Creating the Scenario Map

← Older revision		Revision as of 20:56, 17 April 2018
Line 42:		Line 42:

	Click on the flag, then choose Player 1 (usually the human player) or Player 2 (usually the AI). Now click on the preferred keep. That's it, now you have your leader assigned to the castle. A label with the player name should also appear.		Click on the flag, then choose Player 1 (usually the human player) or Player 2 (usually the AI). Now click on the preferred keep. That's it, now you have your leader assigned to the castle. A label with the player name should also appear.

			Finally, save your new map. Remember the exact path and file name, as we shall need it later on.

	===Creating the Scenario .cfg File===		===Creating the Scenario .cfg File===