Editing XML/Menu

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
−
[[XML|Back to XML Overview ]]
+
{{XMLs}}
−
 
+
The menu XML defines how the menu screen works. It controls the fog, rain, and water level, as well as the camera positions and angles for each menu option. It varies slightly in the differing versions of [[Glest]], since the forks add different menu options, such as [[GAE]]'s save menu. As well, GAE has options to toggle the images and a total conversion option.
−
The menu XML defines how the menu screen works. It controls the fog, rain, and water level, as well as the camera positions and angles for each menu option.
 
−
 
 
  
 +
{{TOC limit|2}}
  
 
==XML==
 
==XML==
 +
{{XML_definition_header}}
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
 
<?xml version="1.0"?>
 
<?xml version="1.0"?>
 
<menu>
 
<menu>
−
<water value="true" height="3" />
+
    <water value="true" height="3" />
−
<rain value="true" />
+
    <rain value="true" />
−
<fog value="true" density="0.025" />
+
    <fog value="true" density="0.025" />
−
<camera>
+
    <camera>
−
<start-position x="5" y="10" z="40" />
+
        <start-position x="5" y="10" z="40" />
−
<root-position x="-9" y="11" z="10" />
+
        <root-position x="-9" y="11" z="10" />
−
<about-position x="6" y="8.5" z="11" />
+
        <about-position x="6" y="8.5" z="11" />
−
<config-position x="4" y="17" z="0" />
+
        <config-position x="4" y="17" z="0" />
−
<info-position x="5" y="6" z="-5" />
+
        <info-position x="5" y="6" z="-5" />
−
<new-game-position x="12" y="17" z="5" />
+
        <new-game-position x="12" y="17" z="5" />
−
<join-game-position x="14" y="15" z="5" />
+
        <join-game-position x="14" y="15" z="5" />
−
<scenario-position x="10" y="13" z="2" />
+
        <scenario-position x="10" y="13" z="2" />
−
<start-rotation x="0" y="0" z="0" />
+
<!-- Start GAE Only -->
−
<root-rotation x="0" y="-40" z="0" />
+
        <loadgame-position x="0" y="20" z="-5" />
−
<about-rotation x="0" y="-80" z="0" />
+
<!-- End GAE Only -->
−
<config-rotation x="0" y="-5" z="0" />
+
 
−
<info-rotation x="0" y="25" z="0" />
+
        <start-rotation x="0" y="0" z="0" />
−
<new-game-rotation x="0" y="10" z="0" />
+
        <root-rotation x="0" y="-40" z="0" />
−
<join-game-rotation x="0" y="12" z="0" />
+
        <about-rotation x="0" y="-80" z="0" />
−
<scenario-rotation x="0" y="-10" z="0" />
+
        <config-rotation x="0" y="-5" z="0" />
−
</camera>
+
        <info-rotation x="0" y="25" z="0" />
 +
        <new-game-rotation x="0" y="10" z="0" />
 +
        <join-game-rotation x="0" y="12" z="0" />
 +
        <scenario-rotation x="0" y="-10" z="0" />
 +
<!-- Start GAE Only -->
 +
        <loadgame-rotation x="-15" y="0" z="0" />
 +
<!-- End GAE Only -->
 +
    </camera>
 +
    <!-- Start GAE Only -->
 +
    <logos>
 +
        <total-conversion value="false" />
 +
        <gae-logo value="false" />
 +
        <gpl-logo value="true" />
 +
    </logos>
 +
    <!-- End GAE Only -->
 +
 
 +
    <!-- Start MG Only -->
 
<intro>
 
<intro>
−
<intro-time value="47500" />
+
<intro-time value="47500"/>
−
<appear-time value="1000" />
+
<appear-time value="1000"/>
−
<show-time value="1500" />
+
<show-time value="1500"/>
−
<disappear-time value="1000" />
+
<disappear-time value="1000"/>
−
<menu-music-path value="/menu/music/" />
+
<menu-music-path value="/menu/music/"/>
−
<menu-intro-music value="intro_music.ogg" />
+
<menu-intro-music value="intro_music.ogg"/>
−
<menu-music value="menu_music.ogg" />
+
<menu-music value="menu_music.ogg"/>
−
<show-intro-pictures value="8" random="true" time="2500" />
+
<show-intro-pictures value="8" random="true" time="2500"/>
−
<show-intro-models value="true" random="true" min-anim-speed="0.010" max-anim-speed="0.6" />
+
<show-intro-models value="true" random="true" min-anim-speed="0.010" max-anim-speed="0.6"/>
 +
 
 
<camera>
 
<camera>
−
<start-position x="6" y="8.5" z="11" />
+
<start-position x="6" y="8.5" z="11"/>
−
<start-rotation x="0" y="-80" z="0" />
+
<start-rotation x="0" y="-80" z="0"/>
 
</camera>
 
</camera>
 +
 
</intro>
 
</intro>
 +
    <!-- End MG Only -->
 
</menu>
 
</menu>
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
 +
==LNG Files==
 +
{{LNG_definition_header}}
 +
;-------------------------------- Intro Text Start
 +
IntroText1=Based on award-winning classic Glest
 +
IntroStartMilliseconds1=1000
 +
IntroText2=the MegaGlest Team presents
 +
IntroStartMilliseconds2=4400
 +
IntroText3=a libre software real-time strategy game
 +
IntroStartMilliseconds3=8400
 +
IntroTexture4=$APPLICATIONDATAPATH/data/core/menu/textures/logo.tga
 +
IntroTextureWidth4=256
 +
IntroTextureHeight4=128
 +
IntroStartMilliseconds4=12000
 +
IntroText5=$GAMEVERSION
 +
IntroTextX5=+5
 +
IntroTextY5=-45
 +
IntroTextFontType5=menunormal
 +
IntroStartMilliseconds5=12000
 +
IntroText6=http://megaglest.org
 +
IntroStartMilliseconds6=16000
 +
IntroModelStartMilliseconds=24000
 +
IntroTextureStartMilliseconds=26000
 +
;-------------------------------- Intro Text End
 +
; Font configuration for FTGL
 +
; Before using an alternative font, please verify license compatibility
 +
ISO639-1=en
 +
NativeLanguageName=English
 +
MEGAGLEST_FONT=$APPLICATIONDATAPATH/data/core/fonts/LinBiolinum_Re-0.6.4.ttf
  
 
==Documentation==
 
==Documentation==
Line 66: Line 115:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
! Element name
 
! Element name
−
! Details
+
! Effect
 
|-
 
|-
−
| start-position
+
| <div id="start-position">start-position</div>
 
| Sets the very first position the camera will be in when the game starts. It will not stay in this position and will move towards the root menu position, so this is entirely a cinematic effect.
 
| Sets the very first position the camera will be in when the game starts. It will not stay in this position and will move towards the root menu position, so this is entirely a cinematic effect.
 
|-
 
|-
−
| root-position
+
| <div id="root-position">root-position</div>
 
| The camera location for the main menu.
 
| The camera location for the main menu.
 
|-
 
|-
−
| about-position
+
| <div id="about-position">about-position</div>
 
| Position for the about screen.
 
| Position for the about screen.
 
|-
 
|-
−
| config-position
+
| <div id="config-position">config-position</div>
 
| Position for the configuration (options) screen.
 
| Position for the configuration (options) screen.
 
|-
 
|-
−
| info-position
+
| <div id="info-position">info-position</div>
 
| Position for the info screen (subscreen in the options menu).
 
| Position for the info screen (subscreen in the options menu).
 
|-
 
|-
−
| new-game-position
+
| <div id="new-game-position">new-game-position</div>
 
| Position for the new game screen.
 
| Position for the new game screen.
 
|-
 
|-
−
| join-game-position
+
| <div id="join-game-position">join-game-position</div>
 
| Position for the join game screen.
 
| Position for the join game screen.
 
|-
 
|-
−
| loadgame-position
+
| <div id="loadgame-position">loadgame-position</div>
 
| Position for the load game screen (GAE only).
 
| Position for the load game screen (GAE only).
 
|-
 
|-
−
| start-rotation
+
| <div id="start-rotation">start-rotation</div>
 
| The direction the camera is facing when the program starts, before it moves for the main menu position.
 
| The direction the camera is facing when the program starts, before it moves for the main menu position.
 
|-
 
|-
−
| root-rotation
+
| <div id="root-rotation">root-rotation</div>
 
| The camera rotation at the main menu.
 
| The camera rotation at the main menu.
 
|-
 
|-
−
| about-rotation
+
| <div id="about-rotation">about-rotation</div>
 
| The camera rotation at the about screen.
 
| The camera rotation at the about screen.
 
|-
 
|-
−
| config-rotation
+
| <div id="config-rotation">config-rotation</div>
 
| The camera rotation at the configuration (options) screen.
 
| The camera rotation at the configuration (options) screen.
 
|-
 
|-
−
| info-rotation
+
| <div id="info-rotation">info-rotation</div>
 
| The camera rotation at the info screen (subscreen in the options menu).
 
| The camera rotation at the info screen (subscreen in the options menu).
 
|-
 
|-
−
| new-game-rotation
+
| <div id="new-game-rotation">new-game-rotation</div>
 
| The camera rotation at the new game screen.
 
| The camera rotation at the new game screen.
 
|-
 
|-
−
| join-game-rotation
+
| <div id="join-game-rotation">join-game-rotation</div>
 
| The camera rotation at the join game screen.
 
| The camera rotation at the join game screen.
−
|}
 
−
 
−
===gpl-logo===
 
−
If true, the GPL logo will be shown at the bottom of the main menu.
 
−
 
−
===intro===
 
−
These settings control the game intro. Modifying this is generally an action of trial and error. All time values are in milliseconds (1 second = 1000 milliseonds).
 
−
 
−
{| class="wikitable sortable"
 
−
! Element name
 
−
! Details
 
−
|-
 
−
| intro-time
 
−
| This is the total amount of time that the intro should display before showing the start menu.
 
−
|-
 
−
| appear-time
 
−
| This is the amount of time that it will take one line of intro data to fade into display.
 
−
|-
 
−
| show-time
 
−
| This is the amount of time that it will take one line of intro data to remain in display after fading in.
 
−
|-
 
−
| disappear-time
 
−
| This is the amount of time that it will take one line of intro data to fade out of display.
 
−
|-
 
−
| menu-music-path
 
−
| The path to menu music files (relative to <tt>data/core/</tt>).
 
−
|-
 
−
| menu-intro-music
 
−
| The name of the intro music file to play (located in ''menu-music-path'').
 
−
|-
 
−
| menu-music
 
−
| The name of the main menu music file to play (located in ''menu-music-path'').
 
−
|-
 
−
| show-intro-pictures
 
−
| This node describes how intro pictures should display.
 
−
 
−
''value''= number of images to display (using the following path and naming: <tt>data/core/menu/textures/intro*.*</tt>).<br />
 
−
''random'' = true or false meaning display order of images should be sequential (false) or random (true).<br />
 
−
''time'' = time in milliseconds to disply the picture.
 
 
|-
 
|-
−
| show-intro-models
+
| <div id="loadgame-rotation">loadgame-rotation</div>
−
| This node describes how intro models should display.
+
| The camera rotation at the load game screen (GAE only).
−
 
 
−
''value'' = true (show intro models) or false (do not show intro models).<br />
 
−
''random'' = true or false meaning display order of models should be sequential (false) or random (true).<br />
 
−
''min-anim-speed'' = minimum animation speed from 0 to 1.<br />
 
−
''max-anim-speed'' = maximum animation speed from 0 to 1.
 
 
|}
 
|}
  
 +
===total-conversion===
 +
A GAE only value that defines whether or not the mod is meant to be a regular mod or a complete conversion. Complete conversions will hide the version numbers and show a different logo at the side.
  
 +
===gae-logo===
 +
If true, an alternative GAE logo will also be shown at the bottom of the main menu. Good for full conversion mods because you can then change the regular logo.
  
−
==Special language strings==
+
===gpl-logo===
−
In MegaGlest, several language strings also effect the introduction, which can modify the images, text, and time to display the text/image.
+
If true, the GPL logo will be shown at the bottom of the main menu.
−
<syntaxhighlight lang="ini">
 
−
IntroText1=Based on award-winning classic Glest
 
−
IntroStartMilliseconds1=1000
 
−
IntroText2=the MegaGlest Team presents
 
−
IntroStartMilliseconds2=4400
 
−
IntroText3=a libre software real-time strategy game
 
−
IntroStartMilliseconds3=8400
 
−
IntroTexture4=$APPLICATIONDATAPATH/data/core/menu/textures/logo.tga
 
−
IntroTextureWidth4=256
 
−
IntroTextureHeight4=128
 
−
IntroStartMilliseconds4=12000
 
−
IntroText5=$GAMEVERSION
 
−
IntroTextX5=+5
 
−
IntroTextY5=-45
 
−
IntroTextFontType5=menunormal
 
−
IntroStartMilliseconds5=12000
 
−
IntroText6=http://megaglest.org
 
−
IntroStartMilliseconds6=16000
 
−
IntroModelStartMilliseconds=24000
 
−
IntroTextureStartMilliseconds=26000
 
−
ISO639-1=en
 
−
NativeLanguageName=English
 
−
MEGAGLEST_FONT=$APPLICATIONDATAPATH/data/core/fonts/LinBiolinum_Re-0.6.4.ttf
 
−
</syntaxhighlight>
 
  
 
==See Also==
 
==See Also==
 
*[[XMLs]]
 
*[[XMLs]]
 +
*[[GAE]]
 
*[[MegaGlest]]
 
*[[MegaGlest]]
−
[[Category:XMLs]]
 
−
[[Category:XMLs]]
 
−
[[Category:XMLs]]
 
−
[[Category:XMLs]]
 
 
[[Category:XMLs]]
 
[[Category:XMLs]]
 
[[Category:XMLs]]
 
[[Category:XMLs]]
 
[[Category:XMLs]]
 
[[Category:XMLs]]
 
[[Category:XMLs]]
 
[[Category:XMLs]]

Please note that all contributions to MegaGlest are considered to be released under the Creative Commons Attribution Share Alike (see MegaGlest:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)
Retrieved from "https://docs.megaglest.org/index.php?title=XML/Menu"