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 ==  
== Set background ==  
Line 56: Line 6:


=== 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" ==
== Arid Background - "arid" ==
Line 87: Line 25:


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


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


== Canyon Background - "canyon" ==
== Canyon Background - "canyon" ==
Line 96: Line 34:


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


== Cliff Background - "cliff" ==
== Cliff Background - "cliff" ==
Line 102: Line 43:


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


== Desert Background - "desert" ==
== Desert Background - "desert" ==
[[File:Desert background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
[[File:Desert background.png]] - [[File:Sand front island.png]] - [[File:Sand back island.png]]
 
== Forest Background - "forest" ==
[[File:Forest background.png]] - [[File:Woodland.png]] - [[File:Woodland.png]]


== Grass Background - "grass ==
== Grass Background - "grass ==
Line 111: Line 55:


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


== Night Arid Background - "night_arid" ==
== Night Arid Background - "night_arid" ==
Line 117: Line 61:


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


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


== Night Canyon Background - "night_canyon" ==
== Night Canyon Background - "night_canyon" ==
Line 129: Line 73:


== Night Desert Background - "night_desert" ==
== Night Desert Background - "night_desert" ==
[[File:Night desert background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
[[File:Night desert background.png]] - [[File:Sand front island.png]] - [[File:Sand back island.png]]
 
== Night Forest Background - "night_forest" ==
[[File:Night forest background.png]] - [[File:Woodland.png]] - [[File:Woodland.png]]


== Night Grass Background - "night_grass" ==
== Night Grass Background - "night_grass" ==
Line 135: Line 82:


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


== Night Plain Background - "night_plain" ==
== Night Plain Background - "night_plain" ==
[[File:Night plain background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
[[File:Night plain background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
== Night Sand Background - "night_sand" ==
[[File:Night sand background.png]] - [[File:Sand front island.png]] - [[File:Sand back island.png]]


== Night Sea Background - "night_sea" ==
== Night Sea Background - "night_sea" ==
[[File:Night sea background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
[[File:Night sea background.png]] - [[File:Rain front island.png]] - [[File:Rain back island.png]]
 
== Night Snow Background - "night_snow" ==
[[File:Night snow background.png]] - [[File:Snow front island.png]] - [[File:Snow back island.png]]


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


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


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


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


== Sea Background - "sea" ==
== Sea Background - "sea" ==
[[File:Sea background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
[[File:Sea background.png]] - [[File:Rain front island.png]] - [[File:Rain back island.png]]
 
== Snow Background - "snow" ==
[[File:Snow background.png]] - [[File:Snow front island.png]] - [[File:Snow back island.png]]


== Snowplain Background - "snowplain" ==
== Snowplain Background - "snowplain" ==
[[File:Snowplain background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
[[File:Snowplain background.png]] - [[File:Ice front island.png]] - [[File:Ice back island.png]]


== Stadium Background - "stadium" ==
== Stadium Background - "stadium" ==
Line 165: Line 124:


== Sunset Background - "sunset" ==
== Sunset Background - "sunset" ==
[[File:Sunset background.png]] - [[File:Terra front island.png]] - [[File:Terra back island.png]]
[[File:Sunset background.png]]
 
== Valley Background - "valley" ==
[[File:Valley background.png]] - [[File:Greengrass front island.png]] - [[File:Greengrass front island.png]]
 
== Unused Terrain ==
 
=== Cavern Background - "cavern" ===
[[File:Cavern background.png]] - [[File:Cave front island.png]] - [[File:Cave front island.png]]
 
=== Forest Background - "forest" ===
[[File:Forest background.png]] - [[File:Woodland.png]] - [[File:Woodland.png]]


=== Night Forest Background - "night_forest" ===
== Underwater Background - "underwater" ==
[[File:Night forest background.png]] - [[File:Woodland.png]] - [[File:Woodland.png]]
 
=== Night Sand Background - "night_sand" ===
[[File:Night sand background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
 
=== Sand Background - "sand" ===
[[File:Sand background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
 
=== Night Snow Background - "night_snow" ===
[[File:Night snow background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
 
=== Snow Background - "snow" ===
[[File:Snow background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
 
=== Underwater Background - "underwater" ===
[[File:Underwater background.png]] - [[File:Big blue front island.png]] - [[File:Big blue front island.png]]
[[File:Underwater background.png]] - [[File:Big blue front island.png]] - [[File:Big blue front island.png]]


== Unused Terrain islands ==
== Valley Background - "valley" ==
[[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"