Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Nqnt41 readme update #6

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Nqnt41 readme update #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1a9c88
Update README.md
Nqnt41 Feb 12, 2024
16879dd
Added How To Play to README.me
Nqnt41 Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 77 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,82 @@
# Digger

Digger game written in JavaScript using the HTML5 canvas element.
[![Website](https://img.shields.io/badge/Website-gray.svg?style=for-the-badge)](https://www.lutzroeder.com/projects/)
[![Contributors](https://img.shields.io/badge/Contributors-1-brightgreen.svg?style=for-the-badge)](https://github.com/lutzroeder/digger/graphs/contributors)
[![Forks](https://img.shields.io/badge/Forks-33-blue.svg?style=for-the-badge)](https://github.com/lutzroeder/digger/stargazers)
[![Stargazers](https://img.shields.io/badge/Stargazers-81-yellow.svg?style=for-the-badge)](https://github.com/lutzroeder/digger/stargazers)
[![Watching](https://img.shields.io/badge/Watching-10-lightgray.svg?style=for-the-badge)](https://github.com/lutzroeder/digger/stargazers)

Use cursor keys, ESC to restart, DEL to jump to the next level.
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#description">Description</a>
</li>
<li><a href="#how-to-play">How to Play</a></li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgements">Acknowledgments</a></li>
</ol>
</details>

[Play](https://lutzroeder.github.io/digger)
## Description
This project showcases the game Digger runnable in browser.

<a href="https://lutzroeder.github.io/digger"><img src=".github/screenshot.png" alt="Screenshot" align="left" width="640"></a>
Written in the Javascript language using the HTML5 canvas element.

[Open the game in browser here!](https://lutzroeder.github.io/digger)

<a href="https://lutzroeder.github.io/digger"><img src=".github/screenshot.png" alt="Screenshot" width="640"></a>

## How to Play
Digger is a puzzle game in which you control an underground explorer searching for riches in treacherous underground mazes.

The primary goal of Digger is to obtain all of the golden diamond tiles on the map while avoiding any hazards or enemies traversing the screen, all within the time limit and without running out of lives.

The game is controlled using the cursor keys, ESC to restart the current screen, and DEL to skip the current level andjump to the next.

The player can dig through any dirt tiles and push any purple boulders into empty spaces, but beware! Boulders as well as the golden diamonds can roll onto the player and crush them if the tiles around them are destroyed.

Destroying tiles also risks releasing enemies trapped behind walls who can destroy the player if confronted recklessly.

To win, one must pay careful attention to the layout of the screen and traverse to collect the diamonds in the safest way possible while having the reflexes to quickly react to any unexpected traps.

## Getting Started

### Prerequisites
* There are no prerequisites to play the game, simply click the link in the project's description.
* If one is a developer who wishes to expand upon the game, the primary prerequisite is installation of [node.js through their website](https://nodejs.org/en/download/package-manager).

### Installation
1. Clone the repo
```sh
git clone https://github.com/lutzroeder/digger.git
```
2. [Install node.js through their website.](https://nodejs.org/en/download/package-manager)
3. Run the makefile provided with the project after cloning it by running the following command from within the local repository:
```sh
make
```

## Contributing

This project is open source and is, as such, open to contributions and changes from others.

If you have any ideas for how to improve the project, please fork this repository and create a pull request.

## Contact

Lutz Roeder - [lutzroeder.com](lutzroeder.com) - [Lutz Roeder on GitHub](https://github.com/lutzroeder) - [Lutz Roeder on LinkedIn](https://www.linkedin.com/in/lutzroeder/) - [@@lutzroeder on Twitter](https://twitter.com/lutzroeder)

## Acknowledgements

Project was created solely by Lutz Roeder, [whose original repository can be found here.](https://github.com/lutzroeder/digger)

README updated by Ryan Coveny, or Nqnt41 on GitHub.