mirror of
https://github.com/wesnoth/wesnoth
synced 2025-05-03 20:28:32 +00:00
A rough framework for an editor help section.
Still contains a lot non-sense and stubs.
This commit is contained in:
fendrin
parent
baf4fec0ad
commit
302d53fca8
@ -3,23 +3,235 @@
|
||||
[section]
|
||||
id=editor
|
||||
title= _ "Map/Scenario Editor"
|
||||
topics=..editor,editor_modes #,masks,selection_tool
|
||||
topics=..editor, editor_overview, editor_modes, editor_toolkit, editor_terrain, editor_masks, editor_named_area, editor_playlist, editor_tool_paint, editor_tool_fill, editor_tool_label, editor_tool_select, editor_tool_paste, editor_tool_item, editor_tool_soundsource, editor_tool_village, editor_tool_unit, editor_tool_starting, editor_palette, editor_brush, editor_clipboard
|
||||
sort_topics=no
|
||||
[/section]
|
||||
|
||||
[topic]
|
||||
id=editor_brush
|
||||
title= _ "Editor Brush"
|
||||
text= _ "TODO"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_clipboard
|
||||
title= _ "Terrain Clipboard"
|
||||
text= _ "TODO"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_paint
|
||||
title= _ "Paint Tool"
|
||||
text= "<img>src=icons/action/editor-tool-paint_60.png align=left box=yes</img>" + _ "Paint terrain tiles on the map.
|
||||
|
||||
The paint tool utilizises the brushes and the terrain palette."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_fill
|
||||
title= _ "Fill Tool"
|
||||
text= _ "Evil Tool for painting."
|
||||
text= "<img>src=icons/action/editor-tool-fill_60.png align=left box=yes</img>" + _ "Fill continuous regions of terrain with a different one! Just great!
|
||||
|
||||
The fill tool utilizises the terrain palette."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_select
|
||||
title= _ "Select Tool"
|
||||
text= "<img>src=icons/action/editor-tool-select_60.png align=left box=yes</img>" + _ "Selects a set of hex fields. The best tool ever!
|
||||
|
||||
This tool utiliarizes the brushes.
|
||||
It is one of my favourite tools although I don't really know how or for what to use it."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_paste
|
||||
title= _ "Paste Tool"
|
||||
text= "<img>src=icons/action/editor-paste_60.png align=left box=yes</img>" + _ "Paste the terrain in the clipboard
|
||||
|
||||
We can't stay here any longer. The Xenomorph might be just around the next corner."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_starting
|
||||
title= _ "Starting Tool"
|
||||
text= "<img>src=icons/action/editor-tool-starting-position_60.png align=left box=yes</img>" + _"Defines the side leader starting position, for free!
|
||||
|
||||
This tool gives only limited control over the start locations of certain whatever."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_label
|
||||
title= _ "Label Tool"
|
||||
text= "<img>src=icons/action/editor-tool-label_60.png align=left box=yes</img>" + _"TODO"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_item
|
||||
title= _ "Item Tool"
|
||||
text= "<img>src=icons/action/editor-tool-item_60.png align=left box=yes</img>" + _"TODO"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_soundsource
|
||||
title= _ "Soundsource Tool"
|
||||
text= "<img>src=icons/action/editor-tool-soundsource_60.png align=left box=yes</img>" + _ "Places Soundsources on your maps!
|
||||
|
||||
This most fabolous tool did not make it into Wesnoth yet and is therefore not implemented yet."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_village
|
||||
title= _ "Village Ownership Tool"
|
||||
text= "<img>src=icons/action/editor-tool-village_60.png align=left box=yes</img>" + _"TODO"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_tool_unit
|
||||
title= _ "Unit Tool"
|
||||
text= "<img>src=icons/action/editor-tool-unit_60.png align=left box=yes</img>" + _"TODO"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_named_area
|
||||
title= _ "Named Areas"
|
||||
text= _ "Named Areas are sets of gamefields which can be addressed during scenario scripting by a given name.
|
||||
|
||||
It can be used to abstract between the implementation of an effect and the map specific setting.
|
||||
This is a very powerful mechanism since it allows generic scenario codings working with different maps providing the needed named locations."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_playlist
|
||||
title= _ "Playlist Manager"
|
||||
text= _ "Saves a list of music tracks defining a random playlist to the scenario.
|
||||
|
||||
Have a look at the addon server for easy to use additional music tracks."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=..editor
|
||||
title= _ "Map/Scenario Editor"
|
||||
generator="contents:editor"
|
||||
text= _ "A look at the editor’s control mechanisms.
|
||||
text= _ "Wesnoth's Map and Scenaerio Editor starts from the <italic>text='Map Editor'</italic>" + _ " Button at the title screen.
|
||||
|
||||
Alternatively you can start it with the commandline
|
||||
<italic>text='wesnoth -e <path/to/the/map/file.cfg>'</italic>
|
||||
|
||||
Have a look at the editor’s concepts and mechanisms:
|
||||
"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_masks
|
||||
title= _ "Editor Mask Usage"
|
||||
text= _ "Masks can be applied to a base map for reusal in several scenarios playing at the same locations."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_toolkit
|
||||
title= _ "Editor Tools"
|
||||
text= _ "At all times one of the editor tools is active. The active tool's context determines the content of the editor palette. And the context menu. And the utilities thingy.
|
||||
|
||||
These are the items of the toolkit in detail:
|
||||
|
||||
<ref>dst='editor_tool_paint' text='Paint Tool'</ref>
|
||||
<ref>dst='editor_tool_fill' text='Fill Tool'</ref>
|
||||
<ref>dst='editor_tool_select' text='Select Tool'</ref>
|
||||
<ref>dst='editor_tool_paste' text='Paste Tool'</ref>
|
||||
<ref>dst='editor_tool_starting' text='Starting Tool'</ref>
|
||||
<ref>dst='editor_tool_label' text='Label Tool'</ref>
|
||||
<ref>dst='editor_tool_item' text='Item Tool'</ref>
|
||||
<ref>dst='editor_tool_soundsource' text='Soundsource Tool'</ref>
|
||||
<ref>dst='editor_tool_village' text='Village Tool'</ref>
|
||||
<ref>dst='editor_tool_unit' text='Unit Tool'</ref>
|
||||
|
||||
"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_terrain
|
||||
title= _ "Terrain Editor"
|
||||
text= _ "The terrain editor's functionality is covered by the <ref>dst='editor_tool_paint' text='Paint'</ref> and <ref>dst='editor_tool_fill' text='Fill Tool'</ref>."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_time_schedule
|
||||
title= _ "Time Schedule Editor"
|
||||
text= _ "TODO"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_overview
|
||||
title= _ "Overview"
|
||||
text= _ "The Editor's main purpose is to create the maps on which every Wesnoth scenario takes place.
|
||||
Those maps provide only a mesh of terrain fields and starting locations.
|
||||
|
||||
<header>text='What you get'</header>" + _ "
|
||||
|
||||
<ref>dst='editor_terrain' text='Terrain Editor'</ref>
|
||||
Easy to use map editor, similar to simple paint applications.
|
||||
|
||||
|
||||
<italic>text='Scenario Editor'</italic>" + _ "
|
||||
|
||||
<ref>dst='editor_playlist' text='Playlist Manager'</ref>
|
||||
Predefine the scenario's music track playlist.
|
||||
|
||||
<italic>text='Time Schedule Editor'</italic>" + _ "
|
||||
|
||||
<header>text='What you *not* get'</header>" + _ "
|
||||
|
||||
<italic>text='WhatYouSeeIsWhatYouGet'</italic>" + _ "
|
||||
The editor is not a WhatYouSeeIsWhatYouGet application.
|
||||
Because which exact graphic tile represents a terrain in the map depends on all terrain rules loaded (which is different between the editor and each other use case) the map won't look exactly the same.
|
||||
|
||||
<italic>text='Event handler scripting gui'</italic>" + _ "
|
||||
The editor is not a tool to help you scripting the scenario's event handlers.
|
||||
It really is not.
|
||||
|
||||
<italic>text='Infinite Backwards Compatability'</italic>" + _ "
|
||||
The editor can't load maps from versions prior to 1.10.
|
||||
TODO is that true?
|
||||
|
||||
<header>text='Basic Concepts'</header>" + _ "
|
||||
<ref>dst='editor_toolkit' text='Editor Toolkit'</ref>
|
||||
<ref>dst='editor_palette' text='Editor Palette'</ref>
|
||||
<ref>dst='editor_brush' text='Editor Brushes'</ref> not sure if it needs a topic on its own
|
||||
<ref>dst='editor_clipboard' text='Editor Clipboard'</ref>
|
||||
"
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_palette
|
||||
title= _ "Editor Palette"
|
||||
text= _ "The editor palette is the niciest widget in all whole world of wesnoth."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=map_format
|
||||
title= _ "Wesnoth Map Format"
|
||||
text= _ "Wesnoth stores its maps in human readable plain text files.
|
||||
|
||||
A map file consists of rows with comma separated terrain code strings.
|
||||
The files can be edited with a general purpose text editor like notepad.
|
||||
|
||||
The only additional information provided by the map syntax are the starting positions of the scenario's sides.
|
||||
|
||||
Additional informations, needed by almost every but the simpliest setup, like sides being grouped into teams,
|
||||
complex side setups or non default victory conditions need a handwritten blah blub."
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=scenario_format
|
||||
title= _ "Scenario Format"
|
||||
text= _ " "
|
||||
[/topic]
|
||||
|
||||
[topic]
|
||||
id=editor_modes
|
||||
title= _ "Editing Modes"
|
||||
|
||||
text= _ "The editor features two separate modes of operation:" + _ "
|
||||
|
||||
<header>text='Pure Map Mode'</header>" + _ "
|
||||
@ -44,14 +256,8 @@ In Scenario mode the terrain data is stored in the map_data= scenario wml attrib
|
||||
bah, too technical"
|
||||
[/topic]
|
||||
|
||||
# [topic]
|
||||
# id=masks
|
||||
# title= _ "Masks"
|
||||
# text= _ "Maks are another issue."
|
||||
# [/topic]
|
||||
|
||||
# [topic]
|
||||
# id=selection_tool
|
||||
# title= _ "Selection Tool"
|
||||
# text= _ "Many words about the cool selection tool"
|
||||
# [/topic]
|
||||
[topic]
|
||||
id=editor_starting_positions_in_general
|
||||
title= _ "Starting Positions Howto"
|
||||
text= _ "TODO"
|
||||
[/topic]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user