amethyst / dwarf_seeks_fortune

A 2D puzzle platformer made with the Amethyst game engine.

⚠️ Note: Since the Amethyst game engine is discontinued, development has similarly halted on this version of Dwarf Seeks Fortune. A new version of the game is being developed using the Bevy engine.

Dwarf Seeks Fortune: Amethyst Edition

A 2D puzzle platformer made with the Amethyst game engine. This game is an homage to the 1988 classic King's Valley II.

Gameplay

You're a dwarf, digging through the ancient ruins of your ancestors. Each level presents a different puzzle. The aim is to collect all keys, after which the door to the next level is unlocked. Puzzle elements include one-time-use tools that must be picked up and used in a specific order at specific locations.

Design goals:

• This project aims to be a helpful resource for people learning Amethyst. Code should ideally be thoroughly documented and easy to understand. It should be kept up to date with the latest stable version of Amethyst and should follow best practices.
• This game should be accompanied by guides explaining how certain features are implemented. These guides should aim to serve as a next step after reading the pong tutorial and the basic examples.
• There is a focus on robustness; for example, someone cloning the repository for the first time should be allowed to accidentally break one of the settings files without it crashing the whole game. Instead, log a warning and use a fallback.
• I personally hate games that make you use the mouse more than necessary. This game must be fully accessible with a keyboard alone. Mouse input should always be optional.

Quickstart

• Clone the repository

git clone https://github.com/amethyst/dwarf_seeks_fortune.git
cd dwarf_seeks_fortune

• Build and run the project

cargo run

For Mac Users

Open the Cargo.toml file and change from vulkan to metal. You have now changed the renderer backend to one that works on MacOS. This step will hopefully become unnecessary in the future.

For Linux Users

You might need to install some dependencies. Please refer to this section of the Amethyst README for more details.

Features:

• In-game level editor. Allows for rapid iteration when designing levels.
• Derpy movement mechanics akin to those of the game this is based on. This game purposely refrains from using a full physics simulation, opting instead for predictable grid-based movements suitable for a puzzle game.
• Multiple playable levels.
• Sound effects and music.
• Time rewinding mechanic to help fix mistakes when solving the puzzles. Might be removed if it proves superfluous or reductive to the experience. For now, it serves as a handy debugging tool.

Art

Sprites are placeholders at the moment, but someone is working on proper pixel art. Sound effects are placeholders as well. Music may or may not be replaced later, it depends on whether I find something more suited to the overall theme of the game.

Contributing

I'd love your contributions! Check out the contributing guidelines to get started.

dwarf_seeks_fortune's Issues

Menu screen goes black after minimizing

After having been minimized while in the menu state, the screen stays black. The game must then be restarted to fix it.

This can possibly have something to do with the camera? The problem does not occur in the editor or play states.

New puzzle element (repeatable)

Design a new puzzle element. The brainstorm document contains some ideas, but you could also invent your own.

An example of a new puzzle element that isn't too involved is the placeable ladder. There is a separate issue for that one.

Tunneling

Currently there is no limit on delta-time. If FPS drops too low, tunneling (e.g. player falling through floor) is inevitable.

This must be fixed.

Level selection

A way to select what level you want to play.

Coming soon.

Change jumping mechanics

Jumping currently has a quick and dirty implementation. There are several issues. The jumping mechanic must be overhauled.

Some concrete issues:

• If you press jump right before running underneath a 2-high ledge, it is possible to jump through the ceiling.
• It is possible to jump across a 4-wide chasm.

Design a level (repeatable)

Use the in-game level designer to create a new level.

There is a level design document available here.

New tool: placeable ladder

Implement a placeable ladder as a new tool. This tool allows the player to place a 2 by 2 bit of ladder directly in front of them. After placing the ladder, it cannot be moved again. Placement is similar to the same way that the hammer tool would take away blocks.

From the brainstorm:

Placeable ladder. Very similar to pushable blocks in purpose, but subtly different. Crucially, the player is able to carry this thing up a ladder. It actually supersedes the pushable block in usability in almost very way, except that a pushable block is reusable whereas a placeable ladder is not.