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.
This DemonCrawl recreation tries to replicate the original DemonCrawl. We use the Godot Game Engine to create a game that not only looks but also feels similar to the original. We try to write the game in such a way that mod support will be feasible.
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.
- Install Godot on the official website.
- If you plan on contributing, you should also install GitHub Desktop.
- Get the source code.
- If you do not plan to contribute, you can do this by cloning this repository or by downloading the source code directly from GitHub.
To clone the repo: On GitHub Desktop, go to
File -> Clone Repository -> URLand paste in this page's URL. Find a suitable location to place the files, and then clickclone. - If you do plan on contributing, you should fork the repository before cloning it. See the Forking the Repository section for details.
- If you do not plan to contribute, you can do this by cloning this repository or by downloading the source code directly from GitHub.
To clone the repo: On GitHub Desktop, go to
- Open the project in Godot:
- Launch Godot Engine.
- Click on
Importand 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.godotfile and open the project.
If you plan on contributing to this project, you should fork this repository before cloning it. To do so, press the Fork button in the top-right corner of the page. This will create a new repository under your account. Then, in GitHub Desktop, go to File -> Clone Repository and find the newly created fork (if it doesn't exist, you may need to restart GitHub Desktop). Next, find a suitable location to place the source code. Then press clone and GitHub Desktop will clone all files in the repository to your pc.
Finally, open the project in Godot by following the above steps.
If you want to update your fork to the latest version of this repository, you can go to Branch -> Update from upstream/main. If there are any new commits on the main branch of this project, they will be copied over to your fork.
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.
As this is an open-source project, any contributions are highly appreciated. If you don't know how to code, that's okay: you can still contribute by researching DemonCrawl mechanics. For example, we don't really know how exactly DemonCrawl generates its quests and stages, especially how it determines each stage's size, monster count, stage power and stage mods.
In addition, you can always help by playtesting the game, and trying to find bugs so we can fix them. If you encounter a bug, don't hesitate to create an issue on GitHub, or report it directly to me and I'll create an issue for you.
If you do know how to code, or are willing to learn it for this project, you can follow these steps to contribute:
- Fork the repository (See the Installation section above)
- Either pick an issue to work on and create a new branch for the issue or immediately create a new branch (on your local fork)
- Make changes
- Commit your changes (remember to do this often so you never lose progress and so that commit titles can still make sense)
- Push to the branch
- Open a pull request and wait for someone to merge the pull request
If you are ever unsure on how to implement something, feel free to contact me on Discord.
There is a style guide in the project's files. Before contributing code, make sure to read that file first and write code in a way that is similar to the rest of the project.
You can contact me on Discord. My username is @elmarhoppieland. You can either contact me on the official DemonCrawl Discord server or in my DMs.