Fantasy-Map-Generator/wiki/README.md

# Fantasy Map Generator Wiki Documentation

This directory contains comprehensive documentation for the Fantasy Map Generator project.

## Documentation Overview

The wiki is organized into the following main sections:

### Core Documentation

1. **[Home](Home.md)** - Wiki homepage with overview and quick links
2. **[Getting Started](Getting-Started.md)** - Beginner's guide for users and developers
3. **[Architecture](Architecture.md)** - System architecture and design patterns
4. **[Data Model](Data-Model.md)** - Complete data structures and relationships
5. **[Generation Process](Generation-Process.md)** - Detailed map generation pipeline
6. **[Modules Reference](Modules-Reference.md)** - Documentation for all modules
7. **[Features and UI](Features-and-UI.md)** - Complete feature list and UI guide

## Quick Navigation

### For Users
- New to the generator? Start with [Getting Started](Getting-Started.md)
- Want to learn all features? See [Features and UI](Features-and-UI.md)
- Need help with something? Check [Home](Home.md) for support links

### For Developers
- Setting up development? See [Getting Started](Getting-Started.md#for-developers)
- Understanding the architecture? Read [Architecture](Architecture.md)
- Working with data? Check [Data Model](Data-Model.md)
- Adding features? Review [Modules Reference](Modules-Reference.md)
- Understanding generation? See [Generation Process](Generation-Process.md)

## What's Documented

### Architecture Documentation
- System design and components
- Module organization and patterns
- Technology stack
- Performance considerations
- SVG layer structure
- Data flow architecture

### Data Model Documentation
- Grid and Pack data structures
- Cell properties and relationships
- Civilization hierarchies
- Biome data
- Data access patterns
- Serialization format
- Performance considerations

### Generation Process Documentation
- Complete 17-stage generation pipeline
- Detailed explanations of each stage
- Algorithms and techniques
- Climate simulation
- Water feature generation
- Civilization creation
- Procedural name generation

### Modules Reference
- All core generator modules
- Civilization generators
- Utility modules
- Renderers
- I/O modules
- UI editors (41+)
- Module APIs and usage

### Features Documentation
- All user-facing features
- Complete UI guide
- Editing capabilities
- Export and save options
- Advanced features
- Keyboard shortcuts
- Tips and troubleshooting

## Documentation Structure

```
wiki/
├── README.md                    # This file
├── Home.md                      # Wiki homepage
├── Getting-Started.md           # Beginner's guide
├── Architecture.md              # System architecture
├── Data-Model.md               # Data structures
├── Generation-Process.md       # Generation pipeline
├── Modules-Reference.md        # Module documentation
└── Features-and-UI.md          # Features and UI guide
```

## Contributing to Documentation

Found an error or want to improve the docs?

1. Documentation is stored in the `wiki/` directory
2. All files are in Markdown format
3. Submit pull requests with improvements
4. Follow the existing structure and style

### Documentation Guidelines

- **Be clear and concise** - Help readers understand quickly
- **Use examples** - Show code snippets and usage
- **Add diagrams** - Visual aids help comprehension
- **Link related topics** - Help readers navigate
- **Keep it updated** - Update docs when code changes

## Additional Resources

### Official Links
- **Live Application**: [azgaar.github.io/Fantasy-Map-Generator](https://azgaar.github.io/Fantasy-Map-Generator)
- **GitHub Repository**: [github.com/Azgaar/Fantasy-Map-Generator](https://github.com/Azgaar/Fantasy-Map-Generator)
- **Discord Community**: [discord.com/invite/X7E84HU](https://discordapp.com/invite/X7E84HU)
- **Reddit Community**: [reddit.com/r/FantasyMapGenerator](https://www.reddit.com/r/FantasyMapGenerator)

### External Documentation
- [Official Wiki](https://github.com/Azgaar/Fantasy-Map-Generator/wiki) - Additional guides
- [Azgaar's Blog](https://azgaar.wordpress.com) - Development blog
- [Trello Board](https://trello.com/b/7x832DG4/fantasy-map-generator) - Development roadmap

## Version Information

This documentation is current as of:
- **Generator Version**: Latest (continuously updated)
- **Documentation Date**: November 2025
- **Status**: Comprehensive initial version

## Feedback

Have suggestions for improving this documentation?

- Open an issue on [GitHub](https://github.com/Azgaar/Fantasy-Map-Generator/issues)
- Discuss on [Discord](https://discordapp.com/invite/X7E84HU)
- Submit a pull request with improvements

## License

This documentation is part of the Fantasy Map Generator project and is licensed under the MIT License.

---

**Happy mapping!** 🗺️