backups/Fantasy-Map-Generator
1
0
Fork 0
mirror of https://github.com/Azgaar/Fantasy-Map-Generator.git synced 2026-02-04 17:41:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Revise README for D&D Grid Auto-Numbering feature

Browse source 
Updated README to reflect D&D grid enhancements and personal contributions.
This commit is contained in:
Richard Standow 2026-01-09 07:33:41 +07:00 • committed by GitHub
parent 2709db62d0
commit 79897a9a2d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 23 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

119
README.md
View file

@ -1,110 +1,37 @@
# Azgaar Fantasy Map Generator - Enhanced Fork
# Azgaar Fantasy Map Generator - D&D Grid Enhancement
# Note: I use AI to assist with my writing due to mild dyslexia and other issues. The ideas and I would say 50% of the code are mine; the formatting is assisted.
This is a personal fork of [Azgaar's Fantasy Map Generator](https://github.com/Azgaar/Fantasy-Map-Generator) with custom enhancements for D&D campaign management.
## Original Project
**Original Repository**: [Azgaar/Fantasy-Map-Generator](https://github.com/Azgaar/Fantasy-Map-Generator)
**Original Author**: Max Haniyeu (Azgaar)
**License**: MIT License
Full credit to Azgaar for creating this incredible fantasy map generation tool. Please visit and star the original repository!
**Note on Tooling & Accessibility:**
I have mild dyslexia and use LLMs/Antigravity AI as technical prosthetics for writing and implementation. I architect the logic, design the structure, and define the best practices; the AI assists with the Java/JavaScript syntax and grammar formatting. If the documentation style seems overly structured, it is an intentional accessibility choice. I am always the one directing the logic and the "why" behind the code.
---
## Custom Enhancements in This Fork
## Project Overview
This is a personal fork of [Azgaar's Fantasy Map Generator](https://github.com/Azgaar/Fantasy-Map-Generator).
### ✨ Grid Auto-Numbering Feature
As a long-time DM and SysAdmin/DevOps engineer, I needed a way to reference specific locations during tabletop sessions without manual tagging. This fork adds a **Grid Auto-Numbering** system designed for D&D campaign management and map indexing.
Added sequential numbering to grid cells for easy location referencing in D&D campaigns.
## Features: Grid Auto-Numbering
This enhancement adds sequential coordinate numbering to grid cells (0001, 0002, 0003, etc.) starting from the top-left of the map.
**Features:**
- Sequential numbering (0001, 0002, 0003...) starting from top-left
- Customizable font size and color
- Toggle on/off in Style panel
- Perfect alignment for pointy hex, square, and truncated square grids
**Usage:**
1. Enable Grid layer (press `G`)
2. Open Style panel → Select "Grid"
3. Check "Show grid numbers"
4. Adjust size and color as desired
**Documentation:** See [`GRID-NUMBERING-README.md`](./GRID-NUMBERING-README.md) for full implementation details.
---
## Running Locally
* **Dynamic Logic:** Numbers align automatically to Pointy Hex, Square, and Truncated Square grids.
* **Style Control:** Font size and color are fully adjustable via the Style panel to ensure readability against different map backgrounds.
* **Integration:** Toggle functionality is built directly into the existing "Grid" layer settings within the Style panel.
* **Documentation:** Technical implementation details and logic can be found in GRID-NUMBERING-README.md.
## Local Setup
```bash
# Clone this fork
git clone [your-fork-url]
# Clone the repository
git clone [https://github.com/rstandow/Fantasy-Map-Generator](https://github.com/rstandow/Fantasy-Map-Generator)
cd Fantasy-Map-Generator
# Open in browser
# Just open index.html in your web browser
# Launch
# This is a client-side application. Open index.html in any modern web browser.
```
---
## Contributing Back to Original Project
If you're interested in the grid numbering feature, please check out the [original Azgaar repository](https://github.com/Azgaar/Fantasy-Map-Generator) and consider starring it! The feature could potentially be contributed upstream if there's interest.
---
## License
This fork maintains the original MIT License. See [LICENSE](./LICENSE) for full details.
**Copyright 2017-2024 Max Haniyeu (Azgaar)**
Grid numbering enhancements © 2024
---
## Acknowledgments
- **Azgaar** - For creating and maintaining this fantastic map generator
- **Original Contributors** - Everyone who has contributed to the main project
- **D&D Community** - For inspiration and use cases
---
**Original README follows below:**
---
# Fantasy Map Generator
Azgaar's _Fantasy Map Generator_ is a free web application that helps fantasy writers, game masters, and cartographers create and edit fantasy maps.
Link: [azgaar.github.io/Fantasy-Map-Generator](https://azgaar.github.io/Fantasy-Map-Generator).
Refer to the [project wiki](https://github.com/Azgaar/Fantasy-Map-Generator/wiki) for guidance. The current progress is tracked in [Trello](https://trello.com/b/7x832DG4/fantasy-map-generator). Some details are covered in my old blog [_Fantasy Maps for fun and glory_](https://azgaar.wordpress.com).
[![preview](https://github.com/Azgaar/Fantasy-Map-Generator/assets/26469650/9502eae9-92e0-4d0d-9f17-a2ba4a565c01)](https://github.com/Azgaar/Fantasy-Map-Generator/assets/26469650/11a42446-4bd5-4526-9cb1-3ef97c868992)
[![preview](https://github.com/Azgaar/Fantasy-Map-Generator/assets/26469650/e751a9e5-7986-4638-b8a9-362395ef7583)](https://github.com/Azgaar/Fantasy-Map-Generator/assets/26469650/e751a9e5-7986-4638-b8a9-362395ef7583)
[![preview](https://github.com/Azgaar/Fantasy-Map-Generator/assets/26469650/b0d0efde-a0d1-4e80-8818-ea3dd83c2323)](https://github.com/Azgaar/Fantasy-Map-Generator/assets/26469650/b0d0efde-a0d1-4e80-8818-ea3dd83c2323)
Join our [Discord server](https://discordapp.com/invite/X7E84HU) and [Reddit community](https://www.reddit.com/r/FantasyMapGenerator) to share your creations, discuss the Generator, suggest ideas and get the most recent updates.
Contact me via [email](mailto:azgaar.fmg@yandex.com) if you have non-public suggestions. For bug reports please use [GitHub issues](https://github.com/Azgaar/Fantasy-Map-Generator/issues) or _#fmg-bugs_ channel on Discord. If you are facing performance issues, please read [the tips](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Tips#performance-tips).
Pull requests are highly welcomed. The codebase is messy and requires re-design. I will appreciate if you start with minor changes. Check out the [data model](https://github.com/Azgaar/Fantasy-Map-Generator/wiki/Data-model) before contributing.
You can support the project on [Patreon](https://www.patreon.com/azgaar).
_Inspiration:_
- Martin O'Leary's [_Generating fantasy maps_](https://mewo2.com/notes/terrain)
- Amit Patel's [_Polygonal Map Generation for Games_](http://www-cs-students.stanford.edu/~amitp/game-programming/polygon-map-generation)
- Scott Turner's [_Here Dragons Abound_](https://heredragonsabound.blogspot.com)
## Contributing / Upstream
This feature was built to solve a specific table-top gaming need for my own D&D world. If there is interest from the main project or other contributors, I am happy to discuss contributing the grid logic back to the original repository.
## Credits & License
* **Original Author:** Max Haniyeu (Azgaar) - [Original Repository](https://github.com/Azgaar/Fantasy-Map-Generator)
* **License:** MIT License
* **Fork Enhancements:** rstandow (2024)