Creates an installer package containing one or more packages from the mse [[file:index|data directory]].
The installer will be written to <tt><em>output.mse-installer</em></tt>. This name can be ommitted, in which case the name of the forst package will be used (in this case <tt>package1.mse-installer</tt>).
The installer will be written to <tt><em>output.mse-installer</em></tt>. This name can be omitted, in which case the name of the first package will be used (in this case <tt>package1.mse-installer</tt>).
@@ -76,14 +76,14 @@ Additional properties are available, depending on the type of field:
| @"multiple choice"@ <<< <<< <<<
'' Multiple choice fields have the same attributes as normal choice fields.''<br/>
To refer to a combination of values in the initial attribute use @choice1, choice2, choice3@.<br/>
These choices must apear in the same order as they do in the @choices@ property.
These choices must appear in the same order as they do in the @choices@ property.
| @"boolean"@ ''A boolean field is a choice field with the choices @"yes"@ and @"no"@.'' <<< <<< <<<
| @"package choice"@
@script@ [[type:script]] Script to apply to values of this field after each change.<br/>
If the script evaluates to a constant (i.e. doesn't use @value@) then values in this field can effectively not be edited.
| ^^^ @match@ [[type:string]] ''required'' Filenames of the pakcages to match, can include wildcards @"*"@. For example @"magic-mana-*.mse-symbol-font"@.
| ^^^ @match@ [[type:string]] ''required'' Filenames of the packages to match, can include wildcards @"*"@. For example @"magic-mana-*.mse-symbol-font"@.
| ^^^ @initial@ [[type:string]] ''required'' Initial package for new values for this field.
| ^^^ @reqired@ [[type:boolean]] @true@ Must a package always be selected? Or is it allowed to select nothing?
| ^^^ @empty name@ [[type:string]] @"None"@ Name of the empty state. Applies only if @required: false@.
@@ -30,10 +30,10 @@ Such a package contains a [[file:format|data file]] called <tt>game</tt> that ha
| @init script@ [[type:script]] @;@ Script to run when this game is loaded,<br/> can set variables
to be used by other scripts in this game or stylesheets using it.
| @set fields@ [[type:list]] of [[type:field]]s Fields for the styling panel.
| @default set style@ [[type:indexmap]] of [[type:style]]s Default style for the set fields, can be overriden by the stylesheet.
| @default set style@ [[type:indexmap]] of [[type:style]]s Default style for the set fields, can be overridden by the stylesheet.
| @card fields@ [[type:list]] of [[type:field]]s Fields for each card.
| @card list color script@ [[type:script]] from fields Script that determines the color of an item in the card list. <br/>If not set uses the @card list colors@ property of the first card field that has it.
| @statistics dimensions@ [[type:list]] of [[type:statistics dimension]]s from fields Dimensions for statistics, a dimension is rougly the same as an axis. <br/>By default all card fields with 'show statistics' set to true are used.
| @statistics dimensions@ [[type:list]] of [[type:statistics dimension]]s from fields Dimensions for statistics, a dimension is roughly the same as an axis. <br/>By default all card fields with 'show statistics' set to true are used.
| @statistics categories@ [[type:list]] of [[type:statistics category]]s from dimensions DOC_MSE_VERSION: not used since 0.3.6
Choices shown on the statistics panel. <br/>By default all statistics dimensions are used.
| @pack items@ [[type:list]] of [[type:pack item]]s DOC_MSE_VERSION: since 0.3.7
...
...
@@ -47,7 +47,7 @@ Such a package contains a [[file:format|data file]] called <tt>game</tt> that ha
| @keywords@ [[type:list]] of [[type:keyword]]s Standard keywords for this game.
| @word lists@ [[type:list]] of [[type:word list]]s Word lists that can be used by text fields.
| @add cards script@ [[type:list]] of [[type:add cards script]]s DOC_MSE_VERSION: since 0.3.7
A list of scripts for convienently adding multiple cards to a set.
A list of scripts for conveniently adding multiple cards to a set.
--Examples--
Look at the game files in the standard MSE distribution for examples.
| @z index@ [[type:int]] @0@ Stacking of this box, fields with a heigher @z index@ are placed on top of those with a lower index.
| @z index@ [[type:int]] @0@ Stacking of this box, fields with a higher @z index@ are placed on top of those with a lower index.
| @left@ [[type:scriptable]] [[type:double]] ''Required'' Distance between left edge of the box and the left of the card in pixels.
| @width@ [[type:scriptable]] [[type:double]] ''Required'' Width of the box in pixels.
| @right@ [[type:scriptable]] [[type:double]] ''Required'' Distance between right edge of the box and the ''left'' of the card in pixels.
...
...
@@ -91,7 +91,7 @@ The rest of the properties depend on the type of [[type:field]] this style is fo
| ^^^ @padding right@ ^^^ ^^^ ^^^
| ^^^ @padding top@ ^^^ ^^^ ^^^
| ^^^ @padding bottom@ ^^^ ^^^ ^^^
| ^^^ @padding left min@ [[type:scriptable]] [[type:double]] ∞ Minimal padding around the field.<br/> When the text is scalled down the padding is scalled as well, but it becomes no smaller than this.
| ^^^ @padding left min@ [[type:scriptable]] [[type:double]] ∞ Minimal padding around the field.<br/> When the text is scaled down the padding is scaled as well, but it becomes no smaller than this.
| ^^^ @padding right min@ ^^^ ^^^ ^^^
| ^^^ @padding top min@ ^^^ ^^^ ^^^
| ^^^ @padding bottom min@ ^^^ ^^^ ^^^
...
...
@@ -116,11 +116,11 @@ The rest of the properties depend on the type of [[type:field]] this style is fo
@popup style@ @"drop down"@ or @"in place"@ @"drop down"@ Where to place the drop down box for editing the value.<br/>
@"drop down"@ places the box below the field, similair to normal combo boxes.<br/>
@"drop down"@ places the box below the field, similar to normal combo boxes.<br/>
@"in place"@ places the box at the mouse coordinates.
| ^^^ @render style@ [[type:choice render style]] @"text"@ How should the field be rendered?
| ^^^ @mask@ [[type:scriptable]] [[type:filename]] ''none'' A mask to apply to the image, black areas in the mask become transparent, similair to [[fun:set_mask]].
| ^^^ @combine@ [[type:combine]] @"normal"@ How to combine the image with the background? Can be overriden using the [[fun:set_combine]] function.
| ^^^ @mask@ [[type:scriptable]] [[type:filename]] ''none'' A mask to apply to the image, black areas in the mask become transparent, similar to [[fun:set_mask]].
| ^^^ @combine@ [[type:combine]] @"normal"@ How to combine the image with the background? Can be overridden using the [[fun:set_combine]] function.
| ^^^ @alignment@ [[type:alignment]] @"stretch"@ Alignment of text and images in the box.
| ^^^ @font@ [[type:font]] Font to use for rendering text (depending on @render style@)
| ^^^ @image@ [[type:image|scriptable image]] Image to show (depending on @render style@).<br/>
...
...
@@ -131,7 +131,7 @@ The rest of the properties depend on the type of [[type:field]] this style is fo
This is only useful when the alignment is changed, otherwise it is always equal the box size itself.
| ^^^ @content height@ [[type:double]] ''automatic'' When read from a script, gives the height of the current choice image in this box.
| @"multiple choice"@
@direction@ [[type:direction]] @"left to right"@ Direction the items are layed out in, only when @render style@ is @list@.
@direction@ [[type:direction]] @"left to right"@ Direction the items are laid out in, only when @render style@ is @list@.
| ^^^ @spacing@ [[type:double]] @0@ Spacing between the items.
! <<< <<< <<< <<<
...
...
@@ -151,8 +151,8 @@ The rest of the properties depend on the type of [[type:field]] this style is fo
! <<< <<< <<< <<<
| @"symbol"@ @variations@ [[type:list]] of [[type:symbol variation]]s Available variations of the symbol, a variation describes color and border size.
| ^^^ @min aspec ratio@ [[type:double]] @1@ Bounds for the aspect ratio, @width/height@ symbols can take. This can be used to make non-squary symbols.
| ^^^ @max aspec ratio@ [[type:double]] @1@ ^^^
| ^^^ @min aspect ratio@ [[type:double]] @1@ Bounds for the aspect ratio, @width/height@ symbols can take. This can be used to make non-square symbols.
| ^^^ @max aspect ratio@ [[type:double]] @1@ ^^^
! <<< <<< <<< <<<
| @"info"@ @font@ [[type:font]] ''Required'' Font to render the text.
Strings in [[type:value|text values]] can contain markup tags.
These tags affect the presentation and sometimes the behaviour of the text.
A tag is something like @"<tag>some text</tag>"@, similair to HTML.
A tag is something like @"<tag>some text</tag>"@, similar to HTML.
Tags are closed by the same tag with a @/@ before it.
To represent the character @"<"@ in a tagged string use @"\<"@ in script code.
...
...
@@ -16,7 +16,7 @@ This is written as the character with code 1 in files.
| @"<i>"@ The text inside the tag is italic.
| @"<sym>"@ The text inside the tag is rendered as symbols, if a [[prop:style:symbol font]] is set for the text box.
| @"<color:???>"@ The text inside the tag is rendered with the given [[type:color]].
| @"<size:???>"@ The text inside the tag is rendered with the given font size in points, for example @"<size:12>text</size>"@ makes the text 12 points. The text is scaled down proportianally when it does not fit in a text box and the @scale down to@ attribute allows it.
| @"<size:???>"@ The text inside the tag is rendered with the given font size in points, for example @"<size:12>text</size>"@ makes the text 12 points. The text is scaled down proportionally when it does not fit in a text box and the @scale down to@ attribute allows it.
| @"<line>"@ Line breaks inside this tag use the [[prop:style:line height line]], and they show a horizontal line.
| @"<soft-line>"@ Line breaks inside this tag use the [[prop:style:soft line height]].
| @"<atom>"@ An atomic piece of text. The cursor can never be inside it; it is selected as a whole.
...
...
@@ -41,7 +41,7 @@ This is written as the character with code 1 in files.
| @"<prefix>"@ At the beginning of a string, indicates a part that can not be selected. This tag is automatically inserted by the [[fun:combined_editor]] function.
| @"<suffix>"@ At the end of a string, indicates a part that can not be selected. This tag is automatically inserted by the [[fun:combined_editor]] function.
| @"<sep-soft>"@ Like @"<sep>"@, only hidden. This is inserted by [[fun:combined_editor]]
| @"<soft>"@ Text who's width is ignored for alignment, similair to @"<sep-soft>"@, but not a separator.
| @"<soft>"@ Text who's width is ignored for alignment, similar to @"<sep-soft>"@, but not a separator.
| @"<word-list-?>"@ Indicate that the text inside the tag should be selected from a [[type:word list]].
The <tt>?</tt> must be the name of a word list in the game.
