Difference between revisions of "Battle Terrain"

From Tuxepedia
Jump to navigation Jump to search
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Modders can choose between the following battle terrains.
Battle backgrounds are an important component during the fight.  


== arid_background ==
== File JSON ==  


[[File:Arid background.png]]
Battle Terrains in Tuxemon can be created by adding a JSON file to the <code>mods/tuxemon/db/environment</code> directory.


== beach_background ==
*  "slug": "grass",
bridge_background
*  "battle_music": "music_battle_loop",
canyon_background
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).
cave_background
*    "island_back": "gfx/ui/combat/grass_island.png",
cavern_background
*    "island_front": "gfx/ui/combat/grass_island.png",
cliff_background
*    "background": "gfx/ui/combat/grass_background.png",
clouds_background
the subcategory "battle_graphics" > "hud"
desert_background
*      "hud_player": "gfx/ui/combat/hp_player_nohp.png", -> '''Pairagrin Symbol lv 3'''
forest_background
*      "hud_opponent": "gfx/ui/combat/hp_opponent_nohp.png", -> '''Aardorn Symbol lv 3'''
grass_background
*      "tray_player": "gfx/ui/combat/player_party_tray.png",
night_arid_background
*      "tray_opponent": "gfx/ui/combat/opponent_party_tray.png"
night_beach_background
the subcategory "battle_graphics" > "icons": this manages the small tuxeball icons below the hud (see image below).
night_bridge_background
*      "icon_alive": "gfx/ui/icons/party/party_icon01.png",
night_canyon_background
*      "icon_status": "gfx/ui/icons/party/party_icon02.png",
night_cliff_background
*      "icon_faint": "gfx/ui/icons/party/party_icon03.png",
night_desert_background
*      "icon_empty": "gfx/ui/icons/party/party_empty.png"
night_forest_background
 
night_grass_background
[[File:Battle_screen.png]]
night_ocean_background
 
night_plain_background
Here is an example of what an environment file might look like:
night_sand_background
 
night_sea_background
`mods/tuxemon/db/environment/grass.json`
night_snow_background
 
night_snowplain_background
  json
night_valley_background
  {
ocean_background
  "slug": "grass",
plain_background
  "battle_graphics": {
sand_background
    "island_back": "gfx/ui/combat/grass_island.png",
sea_background
    "island_front": "gfx/ui/combat/grass_island.png",
snow_background
    "background": "gfx/ui/combat/grass_background.png",
snowplain_background
    "hud": {
stadium_background
      "hud_player": "gfx/ui/combat/hp_player_nohp.png",
sunset_background
      "hud_opponent": "gfx/ui/combat/hp_opponent_nohp.png",
underwater_background
      "tray_player": "gfx/ui/combat/player_party_tray.png",
valley_background
      "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".
 
=== Dynamic background ===
It changes depending the time.
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>
    <property name="act1" value="set_variable environment:night_grass"/>
    <property name="cond1" value="is variable_set stage_of_day:night"/>
    <property name="cond2" value="not variable_set environment:night_grass"/>
  </properties>
 
You need to replace '''grass''' and '''night_grass'''.
 
=== Fixed background ===
It doesn't change.
 
  <properties>
    <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" ==
[[File:Bridge background.png]] - [[File:Cobble front island.png]] - [[File:Cobble front island.png]]
 
== Canyon Background - "canyon" ==
[[File:Canyon background.png]] - [[File:Dried mud front island.png]] - [[File:Dried mud back island.png]]
 
== Cave Background - "cave" ==
[[File:Cave background.png]] - [[File:Cave front island.png]] - [[File:Cave front island.png]]
 
== Cliff Background - "cliff" ==
[[File:Cliff background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
 
== Clouds Background - "clouds" ==
[[File:Clouds background.png]] - [[File:Sky front island.png]] - [[File:Sky back island.png]]
 
== Desert Background - "desert" ==
[[File:Desert background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
 
== Grass Background - "grass ==
[[File:Grass background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
 
== Interior Background - "interior" ==
[[File:Battle bg03.png]] - [[File:Paper front island.png]] - [[File:Paper back island.png]]
 
== Night Arid Background - "night_arid" ==
[[File:Night arid background.png]] - [[File:Dried mud front island.png]] - [[File:Dried mud back island.png]]
 
== Night Beach Background - "night_beach" ==
[[File:Night beach background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
 
== Night Bridge Background - "night_bridge" ==
[[File:Night bridge background.png]] - [[File:Cobble front island.png]] - [[File:Cobble front island.png]]
 
== Night Canyon Background - "night_canyon" ==
[[File:Night canyon background.png]] - [[File:Dried mud front island.png]] - [[File:Dried mud back island.png]]
 
== Night Cliff Background - "night_cliff" ==
[[File:Night cliff background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
 
== Night Desert Background - "night_desert" ==
[[File:Night desert background.png]] - [[File:Sand front island.png]] - [[File:Sand front island.png]]
 
== Night Grass Background - "night_grass" ==
[[File:Night grass background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
 
== Night Ocean Background - "night_ocean" ==
[[File:Night ocean background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
 
== Night Plain Background - "night_plain" ==
[[File:Night plain background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
 
== Night Sea Background - "night_sea" ==
[[File:Night sea background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
 
== Night Snowplain Background - "night_snowplain" ==
[[File:Night snowplain background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
 
== Night Valley Background - "night_valley" ==
[[File:Night valley background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
 
== Ocean Background - "ocean" ==
[[File:Ocean background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
 
== Plain Background - "plain" ==
[[File:Plain background.png]] - [[File:Grass front island.png]] - [[File:Grass front island.png]]
 
== Sea Background - "sea" ==
[[File:Sea background.png]] - [[File:Water front island.png]] - [[File:Water front island.png]]
 
== Snowplain Background - "snowplain" ==
[[File:Snowplain background.png]] - [[File:Snow front island.png]] - [[File:Snow front island.png]]
 
== Stadium Background - "stadium" ==
[[File:Stadium background.png]] - [[File:Stadium front island.png]] - [[File:Stadium back island.png]]
 
== Sunset Background - "sunset" ==
[[File:Sunset background.png]] - [[File:Terra front island.png]] - [[File:Terra back island.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" ===
[[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]]
 
== Unused Terrain islands ==
[[File:Warning front island.png]] - [[File:Warning back island.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]]

Latest revision as of 19:28, 26 January 2024

Battle backgrounds are an important component during the fight.

File JSON[edit | edit source]

Battle Terrains in Tuxemon can be created by adding a JSON file to the mods/tuxemon/db/environment 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"

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[edit | edit source]

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

Dynamic background[edit | edit source]

It changes depending the time. 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>
   <property name="act1" value="set_variable environment:night_grass"/>
   <property name="cond1" value="is variable_set stage_of_day:night"/>
   <property name="cond2" value="not variable_set environment:night_grass"/>
  </properties>

You need to replace grass and night_grass.

Fixed background[edit | edit source]

It doesn't change.

  <properties>
   <property name="act1" value="set_variable environment:interior"/>
   <property name="cond1" value="not variable_set environment:interior"/>
  </properties>

Arid Background - "arid"[edit | edit source]

Arid background.png - Dried mud front island.png - Dried mud back island.png

Beach Background - "beach"[edit | edit source]

Beach background.png - Sand front island.png - Sand front island.png

Bridge Background - "bridge"[edit | edit source]

Bridge background.png - Cobble front island.png - Cobble front island.png

Canyon Background - "canyon"[edit | edit source]

Canyon background.png - Dried mud front island.png - Dried mud back island.png

Cave Background - "cave"[edit | edit source]

Cave background.png - Cave front island.png - Cave front island.png

Cliff Background - "cliff"[edit | edit source]

Cliff background.png - Grass front island.png - Grass front island.png

Clouds Background - "clouds"[edit | edit source]

Clouds background.png - Sky front island.png - Sky back island.png

Desert Background - "desert"[edit | edit source]

Desert background.png - Sand front island.png - Sand front island.png

Grass Background - "grass[edit | edit source]

Grass background.png - Grass front island.png - Grass front island.png

Interior Background - "interior"[edit | edit source]

Battle bg03.png - Paper front island.png - Paper back island.png

Night Arid Background - "night_arid"[edit | edit source]

Night arid background.png - Dried mud front island.png - Dried mud back island.png

Night Beach Background - "night_beach"[edit | edit source]

Night beach background.png - Water front island.png - Water front island.png

Night Bridge Background - "night_bridge"[edit | edit source]

Night bridge background.png - Cobble front island.png - Cobble front island.png

Night Canyon Background - "night_canyon"[edit | edit source]

Night canyon background.png - Dried mud front island.png - Dried mud back island.png

Night Cliff Background - "night_cliff"[edit | edit source]

Night cliff background.png - Grass front island.png - Grass front island.png

Night Desert Background - "night_desert"[edit | edit source]

Night desert background.png - Sand front island.png - Sand front island.png

Night Grass Background - "night_grass"[edit | edit source]

Night grass background.png - Grass front island.png - Grass front island.png

Night Ocean Background - "night_ocean"[edit | edit source]

Night ocean background.png - Water front island.png - Water front island.png

Night Plain Background - "night_plain"[edit | edit source]

Night plain background.png - Grass front island.png - Grass front island.png

Night Sea Background - "night_sea"[edit | edit source]

Night sea background.png - Water front island.png - Water front island.png

Night Snowplain Background - "night_snowplain"[edit | edit source]

Night snowplain background.png - Snow front island.png - Snow front island.png

Night Valley Background - "night_valley"[edit | edit source]

Night valley background.png - Grass front island.png - Grass front island.png

Ocean Background - "ocean"[edit | edit source]

Ocean background.png - Water front island.png - Water front island.png

Plain Background - "plain"[edit | edit source]

Plain background.png - Grass front island.png - Grass front island.png

Sea Background - "sea"[edit | edit source]

Sea background.png - Water front island.png - Water front island.png

Snowplain Background - "snowplain"[edit | edit source]

Snowplain background.png - Snow front island.png - Snow front island.png

Stadium Background - "stadium"[edit | edit source]

Stadium background.png - Stadium front island.png - Stadium back island.png

Sunset Background - "sunset"[edit | edit source]

Sunset background.png - Terra front island.png - Terra back island.png

Valley Background - "valley"[edit | edit source]

Valley background.png - Greengrass front island.png - Greengrass front island.png

Unused Terrain[edit | edit source]

Cavern Background - "cavern"[edit | edit source]

Cavern background.png - Cave front island.png - Cave front island.png

Forest Background - "forest"[edit | edit source]

Forest background.png - Woodland.png - Woodland.png

Night Forest Background - "night_forest"[edit | edit source]

Night forest background.png - Woodland.png - Woodland.png

Night Sand Background - "night_sand"[edit | edit source]

Night sand background.png - Sand front island.png - Sand front island.png

Sand Background - "sand"[edit | edit source]

Sand background.png - Sand front island.png - Sand front island.png

Night Snow Background - "night_snow"[edit | edit source]

Night snow background.png - Snow front island.png - Snow front island.png

Snow Background - "snow"[edit | edit source]

Snow background.png - Snow front island.png - Snow front island.png

Underwater Background - "underwater"[edit | edit source]

Underwater background.png - Big blue front island.png - Big blue front island.png

Unused Terrain islands[edit | edit source]

Warning front island.png - Warning back island.png Leather front island.png - Leather back island.png Parque front island.png - Parque back island.png Ice front island.png - Ice back island.png Rain front island.png - Rain back island.png