https://github.com/mpewsey/maniamap.godot

Procedural generation of metroidvania style maps for Godot .NET.
https://github.com/mpewsey/maniamap.godot

godot godot4 metroidvania procedural-generation rougelike

Last synced: about 1 month ago
JSON representation

Procedural generation of metroidvania style maps for Godot .NET.

• Host: GitHub
• URL: https://github.com/mpewsey/maniamap.godot
• Owner: mpewsey
• License: bsd-3-clause
• Created: 2024-05-03T15:17:05.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T15:32:22.000Z (7 months ago)
• Last Synced: 2024-05-22T20:32:32.732Z (7 months ago)
• Topics: godot, godot4, metroidvania, procedural-generation, rougelike
• Language: GDScript
• Homepage: https://mpewsey.github.io/ManiaMap.Godot
• Size: 7.58 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ManiaMap.Godot

[![Tests](https://github.com/mpewsey/ManiaMap.Godot/actions/workflows/tests.yml/badge.svg)](https://github.com/mpewsey/ManiaMap.Godot/actions/workflows/tests.yml)

[![Docs](https://github.com/mpewsey/ManiaMap.Godot/actions/workflows/docs.yml/badge.svg?event=push)](https://github.com/mpewsey/ManiaMap.Godot/actions/workflows/docs.yml)

![Godot .NET](https://img.shields.io/badge/Godot%20.NET-4.2%20|%204.3-blue)

![Version](https://img.shields.io/github/v/tag/mpewsey/ManiaMap.Godot?label=Version)

## About

This package provides components for interfacing the [ManiaMap](https://github.com/mpewsey/ManiaMap) procedural layout generator with Godot .NET.

![BigMap](https://user-images.githubusercontent.com/23442063/158001876-cb3962a8-9826-44e9-bb19-a5779e3f99d6.png)

## Installation

1. Install the `MPewsey.ManiaMap` NuGet package in your Godot project. In Visual Studio, this can be done through `Project > Manage NuGet Packages...`, then searching for the package.

2. Copy the `addons/mpewsey.maniamap` directory from this repository into the `addons` folder of your Godot project.

3. Build your Godot project solution, so that the newly incorporated C# addon scripts are compiled.

4. Enable the addon by going to `Project > Project Settings` and clicking the enable checkbox next to the `ManiaMap.Godot` plugin.

## Documentation

For information on the scripting API, as well as instructions related to procedurally generating a room layout, see the [documentation](https://mpewsey.github.io/ManiaMap.Godot/md_pages_layout_generation_instructions.html).

## Samples

Sample scenes are available in the `samples` directory. To explore them, clone this repository, open it in Godot, and perform Steps 3 through 4 under [Installation](#Installation). The requisite NuGet package dependencies should automatically be downloaded when building in Visual Studio.

    

        

            


            Layout tile map book sample with onionskin map display.

        

        

            


            Layout tile map sample.

        

    

    

        

            


            2D layout generation sample.

        

        

            


            Multi-layer 3D layout generation sample.