MapGenerator

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

<!-- ALL-CONTRIBUTORS-BADGE:END --> <br /> <p align="center"> <a href="https://github.com/probabletrain/mapgenerator"> <img src="docs/images/logo.png" alt="Logo" width="125" height="125"> </a> <h3 align="center">Map Generator</h3> <p align="center"> Create procedural American-style cities <br /> <a href="https://probabletrain.itch.io/city-generator"><strong>Open Generator »</strong></a> <br /> <br /> <a href="https://maps.probabletrain.com" target="_blank">Read the Docs</a> · <a href="https://github.com/probabletrain/mapgenerator/issues">Report Bug</a> · <a href="https://github.com/probabletrain/mapgenerator/issues">Request Feature</a> </p> </p>

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

<!-- TODO YT video -->

This tool procedurally generates images of city maps. The process can be automated, or controlled at each stage give you finer control over the output. 3D models of generated cities can be downloaded as a .stl. The download is a zip containing multiple .stl files for different components of the map. Images of generated cities can be downloaded as a .png or an .svg. There are a few choices for drawing style, ranging from colour themes similar to Google or Apple maps, to a hand-drawn sketch.

Built With

• Typescript
• Gulp

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

• npm

npm install npm@latest -g

• Gulp

npm install --global gulp-cli

Installation

1. Clone the mapgenerator

git clone https://github.com/probabletrain/mapgenerator.git

2. Install NPM packages

cd mapgenerator
npm install

3. Build with Gulp. This will watch for changes to any Typescript files. If you edit the HTML or CSS you will have to rerun this command. Gulp Notify sends a notification whenever a build finishes.

gulp

4. Open dist/index.html in a web browser, refresh the page whenever the project is rebuilt.

Usage

See the documentation.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://github.com/trees-and-airlines"><img src="https://avatars3.githubusercontent.com/u/63573826?v=4" width="100px;" alt=""/><br />_{<b>trees-and-airlines</b>}</a><br /><a href="#infra-trees-and-airlines" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td> <td align="center"><a href="https://github.com/ProbableTrain"><img src="https://avatars2.githubusercontent.com/u/33726340?v=4" width="100px;" alt=""/><br />_<b>Keir</b></a><br /><a href="https://github.com/ProbableTrain/MapGenerator/commits?author=ProbableTrain" title="Code">💻</a></td> <td align="center"><a href="https://github.com/ersagunkuruca"><img src="https://avatars3.githubusercontent.com/u/8115002?v=4" width="100px;" alt=""/><br />_{<b>Ersagun Kuruca</b>}</a><br /><a href="https://github.com/ProbableTrain/MapGenerator/commits?author=ersagunkuruca" title="Code">💻</a></td> <td align="center"><a href="https://github.com/Jason-Patrick"><img src="https://avatars3.githubusercontent.com/u/65310110?v=4" width="100px;" alt=""/><br />_{<b>Jason-Patrick</b>}</a><br /><a href="https://github.com/ProbableTrain/MapGenerator/commits?author=Jason-Patrick" title="Code">💻</a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!

Contact

Keir - @probabletrain - probabletrain@gmail.com

Project Link: https://github.com/probabletrain/mapgenerator

License

Distributed under the LGPL-3.0 License. See COPYING and COPYING.LESSER for more information.