feat: adding custom classes and types

README.md

@@ -144,6 +144,27 @@ Any other layers will be rendered visually but have no impact on the game automa
 additional custom behavior by accessing the layers via `LeapGame.map.tiledMap` and integrating your
 own special behavior for tiles or objects.
 
+#### Customizing layer names and classes
+
+Even though the structure explained above should always be followed, the developer can ask Leap
+to use different classes, types, names.
+
+In order to do so, set a new `LeapOptions` to `LeapOptions.defaults` before loading a map:
+
+```dart
+LeapOptions.defaults = const LeapOptions(
+    groundLayerName: 'Ground',
+    metadataLayerName: 'Metadata',
+    playerSpawnClass: 'PlayerSpawn',
+    hazardClass: 'Hazard',
+    damageProperty: 'Damage',
+    platformClass: 'Platform',
+    slopeType: 'Slope',
+    slopeRightTopProperty: 'RightTop',
+    slopeLeftTopProperty: 'LeftTop',
+  );
+```
+
 ## Roadmap 🚧
 
 - Improved collision detection API.
@@ -162,4 +183,4 @@ own special behavior for tiles or objects.
     - `melos analyze`
     - `melos test`
 2. Start your PR title with a [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/)
-   type (feat:, fix: etc).
+   type (feat:, fix: etc).

examples/standard_platformer/pubspec.lock

@@ -201,7 +201,7 @@ packages:
       path: "../../packages/leap"
       relative: true
     source: path
-    version: "0.1.0"
+    version: "0.2.0"
   material_color_utilities:
     dependency: transitive
     description:

examples/standard_platformer/pubspec.yaml

@@ -8,9 +8,9 @@ environment:
   flutter: 3.13.2
 
 dependencies:
-  flame: ^1.9.1
+  flame: ^1.10.0
   flame_audio: ^2.1.1
-  flame_tiled: ^1.14.1
+  flame_tiled: ^1.15.0
   flutter:
     sdk: flutter
   leap:

packages/leap/lib/leap.dart

@@ -3,4 +3,5 @@ export 'src/entities/entities.dart';
 export 'src/input.dart';
 export 'src/leap_game.dart';
 export 'src/leap_map.dart';
+export 'src/leap_options.dart';
 export 'src/leap_world.dart';

packages/leap/lib/src/leap_map.dart

@@ -2,14 +2,15 @@ import 'package:flame/cache.dart';
 import 'package:flame/components.dart';
 import 'package:flame_tiled/flame_tiled.dart';
 import 'package:flutter/services.dart';
-import 'package:leap/src/entities/entities.dart';
-import 'package:leap/src/leap_game.dart';
+import 'package:leap/leap.dart';
 
 /// This component encapsulates the Tiled map, and in particular builds the
 /// grid of ground tiles that make up the terrain of the game.
 class LeapMap extends PositionComponent with HasGameRef<LeapGame> {
   LeapMap({required this.tileSize, required this.tiledMap}) {
-    groundLayer = getTileLayer<TileLayer>('Ground');
+    groundLayer = getTileLayer<TileLayer>(
+      LeapOptions.defaults.groundLayerName,
+    );
 
     // Size of the map component is based on the tile map's grid.
     width = tiledMap.tileMap.map.width * tileSize;
@@ -63,10 +64,12 @@ class LeapMap extends PositionComponent with HasGameRef<LeapGame> {
 
   /// Spawn location for the player.
   Vector2 get playerSpawn {
-    final metadataLayer = tiledMap.tileMap.getLayer<ObjectGroup>('Metadata');
+    final metadataLayer = tiledMap.tileMap.getLayer<ObjectGroup>(
+      LeapOptions.defaults.metadataLayerName,
+    );
     if (metadataLayer != null) {
       final spawn = metadataLayer.objects.firstWhere(
-        (obj) => obj.class_ == 'PlayerSpawn',
+        (obj) => obj.class_ == LeapOptions.defaults.playerSpawnClass,
       );
       return Vector2(spawn.x, spawn.y);
     } else {
@@ -120,25 +123,32 @@ class LeapMapGroundTile extends PhysicalEntity {
   late bool isSlope;
 
   /// Hazards (like spikes) damage on collision.
-  bool get isHazard => tile.class_ == 'Hazard';
+  bool get isHazard => tile.class_ == LeapOptions.defaults.hazardClass;
 
   /// Platforms only collide from above so the player can jump through them
   /// and land on top.
-  bool get isPlatform => tile.class_ == 'Platform';
+  bool get isPlatform => tile.class_ == LeapOptions.defaults.platformClass;
 
   /// Damage to apply when colliding and [isHazard].
   int get hazardDamage {
-    return tile.properties.getValue<int>('Damage') ?? 0;
+    final damage = tile.properties.getValue<int>(
+      LeapOptions.defaults.damageProperty,
+    );
+    return damage ?? 0;
   }
 
   LeapMapGroundTile(
     this.tile,
     this.gridX,
     this.gridY,
   ) : super(static: true, collisionType: CollisionType.tilemapGround) {
-    isSlope = tile.type == 'Slope';
-    rightTop = tile.properties.getValue<int>('RightTop');
-    leftTop = tile.properties.getValue<int>('LeftTop');
+    isSlope = tile.type == LeapOptions.defaults.slopeType;
+    rightTop = tile.properties.getValue<int>(
+      LeapOptions.defaults.slopeRightTopProperty,
+    );
+    leftTop = tile.properties.getValue<int>(
+      LeapOptions.defaults.slopeLeftTopProperty,
+    );
   }
 
   @override

packages/leap/lib/src/leap_options.dart

@@ -0,0 +1,49 @@
+/// A configurable class that allows the developer to
+/// customize names and classes that Leap will look for
+/// when reading the map.
+class LeapOptions {
+  const LeapOptions({
+    this.groundLayerName = 'Ground',
+    this.metadataLayerName = 'Metadata',
+    this.playerSpawnClass = 'PlayerSpawn',
+    this.hazardClass = 'Hazard',
+    this.damageProperty = 'Damage',
+    this.platformClass = 'Platform',
+    this.slopeType = 'Slope',
+    this.slopeRightTopProperty = 'RightTop',
+    this.slopeLeftTopProperty = 'LeftTop',
+  });
+
+  /// The default options for Leap.
+  static LeapOptions defaults = const LeapOptions();
+
+  /// Which layer name should be used for the player, defaults to "Ground".
+  final String groundLayerName;
+
+  /// Which layer name should be used for the metadata, defaults to "Metadata".
+  final String metadataLayerName;
+
+  /// Which class name should be used for the player spawn point,
+  /// defaults to "PlayerSpawn".
+  final String playerSpawnClass;
+
+  /// Whick class name represents hazard objects, defaults to "Hazard".
+  final String hazardClass;
+
+  /// Which property name represents damage, defaults to "Damage".
+  final String damageProperty;
+
+  /// Which class name represents platform objects, defaults to "Platform".
+  final String platformClass;
+
+  /// Which property name represents the slope type, defaults to "Slope".
+  final String slopeType;
+
+  /// Which property name represents the slope left bottom, defaults to
+  /// "RightTop".
+  final String slopeRightTopProperty;
+
+  /// Which property name represents the slope right bottom, defaults to
+  /// "LeftTop".
+  final String slopeLeftTopProperty;
+}