Bevy Mesh Terrain Editor

Deprecated Repo: Please see https://github.com/ethereumdegen/spirit_editor

---

Load, Edit, and Save terrain and other game data files for bevy_mesh_terrain in a standalone application.

Tool Modes

1. Terrain Height
2. Terrain Splat
3. Foliage (warbler grass)
4. Regions
5. Doodad Placement (Press ESC to toggle)

Doodads and zone files

Also, place doodads in zone files (sub-scenes) which can be saved and loaded. These are spawnable entities, used for anything like rocks, trees, even structural GLTFs for your game. These each have a name, a translation, and CustomProps (a hashmap of values: [ vec3,f32,i32,String ....]). In this way, you can load them into your game the way that you need specifically.

Terrain Splat Map

• When painting, the system supports up to 255 textures with high efficiency and very few draw calls. However, the tradeoff is you have to be careful how you blend and paint them. To blend, be sure that you use the 'layer fade' and fade between two textures at every transition or you will get artifact lines. This technique does make painting slightly more tedius but offers extreme splat map optimization and texture capacity in your game.

Placing Doodads

• Create a file at assets/doodad_manifest.manifest.ron and build your doodad definitions in there

 # this is an example doodad manifest file telling the editor how to render (preview) doodads 
 # see doodad_manifest.rs and zone_file.rs for more information about how this works 
  (
    doodad_definitions: [
        (
            name: "birch_yellow_1",
            model: GltfModel("models/doodads/birch_yellow.glb"),
        ) ,
        (
            name: "bonfire",
            model: GltfModel("models/doodads/bonfire.glb"),            ,
            initial_custom_props: Some({ "my_prop": Float(1.0) })
        ) 
    ]
  )

Coordinates

Rotation is EulerRot::YXZ - yaw pitch roll. ex: Typically, trees will only have a yaw rotation.

Zones

• Using the Zones window, you can spawn a zone entity. Right click on this zone entity in the hierarchy to set it as the primary zone. When a zone is primary, placed doodads will become children of the zone

• Right click on the zone entity in the hierarchy to save the zone to a file. You can use the zone window to load zone files back in later.

Exporting files to your game

1. You will need to copy the terrain data folder from the assets folder of this editor to the assets folder of your game after you save your chunks.

2. You will need to either save the scene or save your zone files and then move those files over to your game. I wrote custom import scripts in rust in my games codebase to parse the zone files so my game will know how to spawn the doodads when the player enters the game scene .