spelunking-studios / the-caverns-rust Goto Github PK

Address all the issues presented by a run of clippy on the project.

Abstract

The current plan is to transfer the level files over from the original repository. These files use Tiled simply as a level editor but do not actually use tiles. What I propose instead, is to only use tiles in the level files.

Considerations

Pros:

• Tiles are easily reusable components which will help accelerate the creation of levels
• The structure provided by using a tiling system makes collisions much simpler to implement
• Makes implementing new features such as reactive sections of the map simpler to implement and work with
• Reduces complexity of level systems

Cons:

• Will take some initial effort to translate level files from the original repository
• Will take some initial effort to create the tiles

Design

Level files could be organized to use several different tile layers:

• map: The map graphics. This would be the equivalent of the background in the original level files where the background graphic from the original level files could be broken up into a tile grid with duplicate tiles removed where necessary.
• collisions: Collision tiles such as walls
• reactive: Reactive tiles such as doors
• entities: All entities (in the context of the game, not Bevy). This would include any enemies, passive creatures, or items.

The game needs to have a basic level system that can:

• Switch between levels
• Move forward and backwards between levels
• Supports the concept of "floors" as a collection of levels and "rooms" as an individual level
• Implements an interface that allows tiles to trigger a switch
• Can load and save the current state of "exploration" automatically

Add marker components to tiles to help distinguish between different tiles. This is useful for systems that operate base upon specific types of tiles such as a door tile.

LDTK has a much better editor, native support for Aesprite, and has a better Bevy ecosystem (bevy_ecs_ldtk).

This is screenshot of how it looks:

More specifically, it's the funny lines on the side:

Make it so that when the user opens the game for the first time, and clicks start, the story's intro/background will be shown.