Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anthony-mills/procedural_dungeon
PhaserJS plugin for the procedural generation of dungeon layouts for games.
https://github.com/anthony-mills/procedural_dungeon
dungeon game gamedev html5 maze phaser phaserjs plugin procedural-generation
Last synced: 4 months ago
JSON representation
PhaserJS plugin for the procedural generation of dungeon layouts for games.
- Host: GitHub
- URL: https://github.com/anthony-mills/procedural_dungeon
- Owner: anthony-mills
- License: gpl-3.0
- Created: 2017-05-22T13:32:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-06T10:07:20.000Z (over 5 years ago)
- Last Synced: 2024-09-29T23:48:13.834Z (4 months ago)
- Topics: dungeon, game, gamedev, html5, maze, phaser, phaserjs, plugin, procedural-generation
- Language: JavaScript
- Homepage:
- Size: 466 KB
- Stars: 40
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dungeon Generator PhaserJS Plugin
A PhaserJS plugin to make the procedural generation of mazes and dungeons easy. You can see a [live demo of the plugin working here](https://www.bigsoutherly.com/games/dungeon-generator/).
## Usage
Usage of the plugin for the generation of a dungeon is fairly straight forward:
* Load the script into your [PhaserJS](https://phaser.io/) project
* Initialise the plugin i.e dungeonCreator = game.plugins.addPhaser.Plugin.DungeonCreator);
* Set up any required parameters for your dungeon by passing parameters the setupDungeon method.
* Call the createMap method to generate your dungeon e.g dungeonCreator.createMap();Take a look at demo in the examples/ folder for a basic working implementation.
ydney/new/
## ParametersTo configure the layout of your dungeon. Pass an object with your required parameters to the setupDungeon method.
* wall - The sprite cache key to use for the dungeon walls
* floor - The sprite cache key to use for the dungeon floor
* max_rooms - The maximum number or rooms in the Dungeon
* room_max_size - The maximum size of a room in tiles
* room_min_size - The minimum size of a room in tiles
* map_size_x - The horizontal size of the map in pixels
* map_size_y - The vertical size of the map in pixels## Example Usage
A working example of the plugin is included in the /examples folder of the repo.
![Example use of plugin](/screenshots/example_screenshot.png?raw=true "Plugin Demonstration")
## Licence
Copyright (C) 2017 [Anthony Mills](http://www.anthony-mills.com)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.You should have received a copy of the GNU General Public License
along with this program. If not, see .