Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 2.28 KB

README.md

File metadata and controls

47 lines (32 loc) · 2.28 KB

DemonCrawl

Welcome to the official GitHub repository for the fanmade Godot recreation of DemonCrawl! This project is an open-source, fan-made version of DemonCrawl, attempting to recreate the game as accurately as possible.

Table of Contents

About the Project

This DemonCrawl recreation tries to replicate the original DemonCrawl. Using the Godot Engine, we try to create a game that feels similar to DemonCrawl, while fixing bugs that are present in the original, adding mod support and eventually adding new features.

Installation

When the game is released, there will be a download in the releases secion on this page. Until then, you will have to compile the game yourself by installing Godot.

  1. Install Godot on the official website.
  2. If you plan on contributing, you should also install GitHub Desktop.
  3. Get the source code. You can do this by cloning the repository or by downloading the source code directly from GitHub. To clone the repo: On GitHub Desktop, go to File -> Clone Repository -> URL and paste in this page's URL, then click clone.
  4. Open the project in Godot:
    • Launch Godot Engine.
    • Click on Import and navigate to the folder where you cloned the repository (or where you placed the files if you downloaded the source code directly).
    • Select the project.godot file and open the project.

Usage

To play the game, simply run the project from within the Godot editor by clicking on the Run Project button in the top-right corner of the screen or by pressing F5.

Contributing

Contributions are what make an open-source project work. Any contributions you make can greatly speed up development or simply make the game better. To contribute:

  1. Install the source code (See the Installation section above)
  2. Either pick an issue to work on and create a new branch for the issue or immediately create a new branch
  3. Make changes
  4. Commit your Changes
  5. Push to the Branch
  6. Open a Pull Request and wait for someone to merge the pull request

Contact

You can contact me on Discord. My username is @elmarhoppieland.