Editing Battle Terrain

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 publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
Battle backgrounds are an important component during the fight.  
Battle backgrounds are an important component during the fight.  
== File JSON ==
Battle Terrains in Tuxemon can be created by adding a JSON file to the <code>mods/tuxemon/db/environment</code> directory.
*  "slug": "grass",
*  "battle_music": "music_battle_loop",
the category: "battle_graphics": this is the main category which contains '''hud''' and '''icons''' and it manages the islands (terrain below the monsters) as well as the background. You can see many examples below (islands and backgrounds).
*    "island_back": "gfx/ui/combat/grass_island.png",
*    "island_front": "gfx/ui/combat/grass_island.png",
*    "background": "gfx/ui/combat/grass_background.png",
the subcategory "battle_graphics" > "hud"
*      "hud_player": "gfx/ui/combat/hp_player_nohp.png", -> '''Pairagrin Symbol lv 3'''
*      "hud_opponent": "gfx/ui/combat/hp_opponent_nohp.png", -> '''Aardorn Symbol lv 3'''
*      "tray_player": "gfx/ui/combat/player_party_tray.png",
*      "tray_opponent": "gfx/ui/combat/opponent_party_tray.png"
the subcategory "battle_graphics" > "icons": this manages the small tuxeball icons below the hud (see image below).
*      "icon_alive": "gfx/ui/icons/party/party_icon01.png",
*      "icon_status": "gfx/ui/icons/party/party_icon02.png",
*      "icon_faint": "gfx/ui/icons/party/party_icon03.png",
*      "icon_empty": "gfx/ui/icons/party/party_empty.png"
[[File:Battle_screen.png]]
Here is an example of what an environment file might look like:
`mods/tuxemon/db/environment/grass.json`
  json
  {
  "slug": "grass",
  "battle_graphics": {
    "island_back": "gfx/ui/combat/grass_island.png",
    "island_front": "gfx/ui/combat/grass_island.png",
    "background": "gfx/ui/combat/grass_background.png",
    "hud": {
      "hud_player": "gfx/ui/combat/hp_player_nohp.png",
      "hud_opponent": "gfx/ui/combat/hp_opponent_nohp.png",
      "tray_player": "gfx/ui/combat/player_party_tray.png",
      "tray_opponent": "gfx/ui/combat/opponent_party_tray.png"
    },
    "icons": {
      "icon_alive": "gfx/ui/icons/party/party_icon01.png",
      "icon_status": "gfx/ui/icons/party/party_icon02.png",
      "icon_faint": "gfx/ui/icons/party/party_icon03.png",
      "icon_empty": "gfx/ui/icons/party/party_empty.png"
    }
  },
  "battle_music": "music_battle_loop"
  }
== Set background ==


How do I set up the battle terrain? It depends on your "taste".
How do I set up the battle terrain? It depends on your "taste".


=== Dynamic background ===  
== Dynamic background ==  
It changes depending the time.
It changes depending the time. Night and day.
Day:
 
  <properties>
    <property name="act1" value="set_variable environment:grass"/>
    <property name="cond1" value="not variable_set stage_of_day:night"/>
    <property name="cond2" value="not variable_set environment:grass"/>
  </properties>
 
Night:


  <properties>
* One called "Environment Day"
    <property name="act1" value="set_variable environment:night_grass"/>
* <code>set_variable environment:grass</code>
    <property name="cond1" value="is variable_set stage_of_day:night"/>
* <code>is variable_set daytime:true</code>
    <property name="cond2" value="not variable_set environment:night_grass"/>
  </properties>


You need to replace '''grass''' and '''night_grass'''.
* One called "Environment Night"
* <code>set_variable environment:night_grass</code>
* <code>is variable_set daytime:false</code>


=== Fixed background ===  
== Fixed background ==  
It doesn't change.
It doesn't change.


  <properties>
* <code>set_variable environment:grass</code>
    <property name="act1" value="set_variable environment:interior"/>
    <property name="cond1" value="not variable_set environment:interior"/>
  </properties>
 
== Arid Background - "arid" ==
[[File:Arid background.png]] - [[File:Dried mud front island.png]] - [[File:Dried mud back island.png]]
 
== Beach Background - "beach" ==
[[File:Beach background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]


== Bridge Background - "bridge" ==
== Arid Background ==
[[File:Bridge background.png]] - [[File:Cobble front island.png]] - [[File:Cobble front island.png]]
[[File:Arid background.png]]


== Canyon Background - "canyon" ==
== Beach Background ==
[[File:Canyon background.png]] - [[File:Dried mud front island.png]] - [[File:Dried mud back island.png]]
[[File:Beach background.png]]


== Cave Background - "cave" ==
== Bridge Background ==
[[File:Cave background.png]] - [[File:Cave front island.png]] - [[File:Cave front island.png]]
[[File:Bridge background.png]]


== Cliff Background - "cliff" ==
== Canyon Background ==
[[File:Cliff background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Canyon background.png]]


== Clouds Background - "clouds" ==
== Cave Background ==
[[File:Clouds background.png]] - [[File:Sky front island.png]] - [[File:Sky back island.png]]
[[File:Cave background.png]]


== Desert Background - "desert" ==
== Cavern Background ==
[[File:Desert background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
[[File:Cavern background.png]]


== Grass Background - "grass ==
== Cliff Background ==
[[File:Grass background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Cliff background.png]]


== Interior Background - "interior" ==
== Clouds Background ==
[[File:Battle bg03.png]] - [[File:Paper front island.png]] - [[File:Paper back island.png]]
[[File:Clouds background.png]]


== Night Arid Background - "night_arid" ==
== Desert Background ==
[[File:Night arid background.png]] - [[File:Dried mud front island.png]] - [[File:Dried mud back island.png]]
[[File:Desert background.png]]


== Night Beach Background - "night_beach" ==
== Forest Background ==
[[File:Night beach background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
[[File:Forest background.png]]


== Night Bridge Background - "night_bridge" ==
== Grass Background ==
[[File:Night bridge background.png]] - [[File:Cobble front island.png]] - [[File:Cobble front island.png]]
[[File:Grass background.png]]


== Night Canyon Background - "night_canyon" ==
== Interior Background ==
[[File:Night canyon background.png]] - [[File:Dried mud front island.png]] - [[File:Dried mud back island.png]]
[[File:Battle bg03.png]]


== Night Cliff Background - "night_cliff" ==
== Night Arid Background ==
[[File:Night cliff background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Night arid background.png]]


== Night Desert Background - "night_desert" ==
== Night Beach Background ==
[[File:Night desert background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
[[File:Night beach background.png]]


== Night Grass Background - "night_grass" ==
== Night Bridge Background ==
[[File:Night grass background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Night bridge background.png]]


== Night Ocean Background - "night_ocean" ==
== Night Canyon Background ==
[[File:Night ocean background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
[[File:Night canyon background.png]]


== Night Plain Background - "night_plain" ==
== Night Cliff Background ==
[[File:Night plain background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Night cliff background.png]]


== Night Sea Background - "night_sea" ==
== Night Desert Background ==
[[File:Night sea background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
[[File:Night desert background.png]]


== Night Snowplain Background - "night_snowplain" ==
== Night Forest Background ==
[[File:Night snowplain background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
[[File:Night forest background.png]]


== Night Valley Background - "night_valley" ==
== Night Grass Background ==
[[File:Night valley background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Night grass background.png]]


== Ocean Background - "ocean" ==
== Night Ocean Background ==
[[File:Ocean background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
[[File:Night ocean background.png]]


== Plain Background - "plain" ==
== Night Plain Background ==
[[File:Plain background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Night plain background.png]]


== Sea Background - "sea" ==
== Night Sand Background ==
[[File:Sea background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
[[File:Night sand background.png]]


== Snowplain Background - "snowplain" ==
== Night Sea Background ==
[[File:Snowplain background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
[[File:Night sea background.png]]


== Stadium Background - "stadium" ==
== Night Snow Background ==
[[File:Stadium background.png]] - [[File:Stadium front island.png]] - [[File:Stadium back island.png]]
[[File:Night snow background.png]]


== Sunset Background - "sunset" ==
== Night Snowplain Background ==
[[File:Sunset background.png]] - [[File:Terra front island.png]] - [[File:Terra back island.png]]
[[File:Night snowplain background.png]]


== Valley Background - "valley" ==
== Night Valley Background ==
[[File:Valley background.png]] - [[File:Greengrass front island.png]] - [[File:Greengrass front island.png]]
[[File:Night valley background.png]]


== Unused Terrain ==  
== Ocean Background ==
[[File:Ocean background.png]]


=== Cavern Background - "cavern" ===
== Plain Background ==
[[File:Cavern background.png]] - [[File:Cave front island.png]] - [[File:Cave front island.png]]
[[File:Plain background.png]]


=== Forest Background - "forest" ===
== Sand Background ==
[[File:Forest background.png]] - [[File:Woodland.png]] - [[File:Woodland.png]]
[[File:Sand background.png]]


=== Night Forest Background - "night_forest" ===
== Sea Background ==
[[File:Night forest background.png]] - [[File:Woodland.png]] - [[File:Woodland.png]]
[[File:Sea background.png]]


=== Night Sand Background - "night_sand" ===
== Snow Background ==
[[File:Night sand background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
[[File:Snow background.png]]


=== Sand Background - "sand" ===
== Snowplain Background ==
[[File:Sand background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
[[File:Snowplain background.png]]


=== Night Snow Background - "night_snow" ===
== Stadium Background ==
[[File:Night snow background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
[[File:Stadium background.png]]


=== Snow Background - "snow" ===
== Sunset Background ==
[[File:Snow background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
[[File:Sunset background.png]]


=== Underwater Background - "underwater" ===
== Underwater Background ==
[[File:Underwater background.png]] - [[File:Big blue front island.png]] - [[File:Big blue front island.png]]
[[File:Underwater background.png]]


== Unused Terrain islands ==
== Valley Background ==
[[File:Warning front island.png]] - [[File:Warning back island.png]]
[[File:Valley background.png]]
[[File:Leather front island.png]] - [[File:Leather back island.png]]
[[File:Parque front island.png]] - [[File:Parque back island.png]]
[[File:Ice front island.png]] - [[File:Ice back island.png]]
[[File:Rain front island.png]] - [[File:Rain back island.png]]

Please note that all contributions to Tuxepedia are considered to be released under the Creative Commons Attribution-ShareAlike (see Tuxepedia: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!

Cancel Editing help (opens in new window)
Retrieved from "https://wiki.tuxemon.org/Battle_Terrain"