6afa016920
Add detailed documentation to help AI assistants understand and work with the Fantasy Map Generator codebase, including: - Project architecture and technology stack - Directory structure and file organization - Data model and core concepts (pack object, Voronoi mesh) - Code conventions and module patterns - Development workflow and versioning process - Common development tasks and patterns - Performance considerations and best practices - Troubleshooting guide and quick reference This guide provides AI assistants with essential context about the codebase's unique characteristics (no build system, global object pattern, typed arrays, D3.js rendering) to enable more effective contributions. |
||
|---|---|---|
| .docker | ||
| .github | ||
| .vscode | ||
| charges | ||
| components | ||
| config | ||
| heightmaps | ||
| images | ||
| libs | ||
| modules | ||
| styles | ||
| utils | ||
| .gitignore | ||
| CLAUDE.md | ||
| CODE_OF_CONDUCT.md | ||
| Dockerfile | ||
| dropbox.html | ||
| icons.css | ||
| index.css | ||
| index.html | ||
| ISSUE_TEMPLATE.md | ||
| LICENSE | ||
| main.js | ||
| manifest.webmanifest | ||
| README.md | ||
| run_php_server.bat | ||
| run_python_server.bat | ||
| run_python_server.sh | ||
| sw.js | ||
| versioning.js | ||
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.
Refer to the project wiki for guidance. The current progress is tracked in Trello. Some details are covered in my old blog Fantasy Maps for fun and glory.
Join our Discord server and Reddit community to share your creations, discuss the Generator, suggest ideas and get the most recent updates.
Contact me via email if you have non-public suggestions. For bug reports please use GitHub issues or #fmg-bugs channel on Discord. If you are facing performance issues, please read the 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 before contributing.
You can support the project on Patreon.
Inspiration:
-
Martin O'Leary's Generating fantasy maps
-
Amit Patel's Polygonal Map Generation for Games
-
Scott Turner's Here Dragons Abound