@mitchallen/maze-generator-core
maze generator core
Installation
You must use npm 2.7.0 or higher because of the scoped package name.
$ npm init
$ npm install @mitchallen/maze-generator-core --save
Usage
let cgFactory = require("@mitchallen/connection-grid-square"),
mazeCore = require("@mitchallen/maze-generator-core");
spec = spec || {};
let _x = spec.x || 5;
let _y = spec.y || 6;
let _gridSpec = {
x: _x,
y: _y
};
let _connectionGrid = cgFactory.create(_gridSpec);
if(!_connectionGrid) {
return null;
}
let maze = mazeCore.create( {
grid: _connectionGrid,
});
maze.generate();Browser Usage
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Maze Generator Core Example</title>
<meta name="description" content="Maze Generator Core Example">
<script src="https://unpkg.com/@mitchallen/maze-generator-core@0.1.11/dist/maze-generator-core.min.js"></script>
<script src="https://unpkg.com/@mitchallen/connection-grid-square@0.1.14/dist/connection-grid-square.min.js"></script>
<script>
var cgFactory = window.MitchAllen.ConnectionGridSquare;
console.log(cgFactory);
var xSize = 10, ySize = 5;
var cGrid = cgFactory.create( { x: xSize, y: ySize } );
var factory = window.MitchAllen.MazeGeneratorCore;
var sm = factory.create({
grid: cGrid,
});
console.log(sm);
sm.generate();
sm.log();
</script>
</head>
<body>
<h1>Maze Generator Core Example</h1>
<p>See JavaScript developer console for output.</p>
</body>
</html>Documentation
Testing
To test, go to the root folder and type (sans $):
$ npm test
Repo(s)
Contributing
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
Version History
Version 0.1.7
- updated dependencies
- updated client example
Version 0.1.6
- changed openBorder to afterGenerate to make it more generic
- integrated travis-ci and codecov.io
- changed license to MIT
- updated test cases for 100% code coverage
Version 0.1.5
- added openBorder placeholder method for derived classes
- updated documentation
Version 0.1.4
- refactored generate method
Version 0.1.3
- updated browser example
Version 0.1.2
- removed file that wasn't being used.
Version 0.1.1
- updated browser example to log array
Version 0.1.0
- initial release