MAID Community¶
Welcome to the MAID community! We're building more than just a MUD engine - we're building a community of developers, game creators, and enthusiasts who share a passion for text-based gaming and modern software development.
Ways to Connect¶
GitHub Discussions¶
Our primary community hub for questions, ideas, and general discussion.
- Announcements: Official project announcements and updates
- Q&A: Get help with MAID development
- Ideas: Share feature suggestions
- Show and Tell: Share your content packs and games
- General: Chat about MUDs, game design, and more
GitHub Issues¶
Found a bug or have a specific feature request?
- Bug Reports: Help us improve MAID stability
- Feature Requests: Suggest new capabilities
- Good First Issues: Perfect for new contributors
Discord Server¶
Coming soon!
We're setting up a Discord server for real-time chat. Stay tuned for the announcement!
In the meantime, use GitHub Discussions for community interaction.
If you're setting up your own Discord community for a MAID-based game, see our Discord Server Setup Guide for recommended channel structures, roles, and best practices.
Get Involved¶
Contributing Code¶
Whether you're fixing a typo or implementing a major feature, we welcome your contributions!
Getting Started:
- Read our Contributing Guide
- Find a good first issue
- Fork the repository and make your changes
- Submit a pull request
Creating Content Packs¶
Build your own game content and share it with the community!
Resources:
Improving Documentation¶
Documentation is one of the most valuable contributions. Help us make MAID easier to learn!
Ways to help:
- Fix typos and clarify confusing sections
- Write tutorials and guides
- Add code examples
- Translate documentation (future)
Answering Questions¶
Help fellow community members by:
- Answering questions in GitHub Discussions
- Reviewing pull requests
- Sharing your expertise in issues
Recognition Programs¶
We believe in recognizing everyone who contributes to MAID.
AUTHORS.md¶
All contributors are listed in our AUTHORS.md file. Add yourself when your first PR is merged!
Contributor Spotlights¶
We feature community members in our Contributor Spotlight series. These posts highlight contributors' journeys, advice, and achievements.
Recent Spotlights:
Coming soon - be our first featured contributor!
Release Credits¶
Every release includes credits for contributors. Your work is acknowledged in:
- Release notes
- Changelog entries
- Version documentation
Community Guidelines¶
Code of Conduct¶
We are committed to providing a welcoming and inclusive experience for everyone.
Our standards:
- Be respectful and inclusive
- Welcome newcomers warmly
- Give and receive constructive feedback gracefully
- Focus on what's best for the community
Read our full Code of Conduct.
Communication Guidelines¶
- Be patient: Remember that everyone is volunteering their time
- Be clear: Provide context and details in your questions
- Be helpful: Share knowledge and help others learn
- Be positive: Celebrate successes and support each other
Events¶
Community Meetings¶
Coming soon!
We plan to hold regular community meetings to discuss:
- Project roadmap and priorities
- Feature proposals and RFCs
- Community feedback and ideas
Game Jams¶
Coming soon!
We're planning content pack creation events where community members can:
- Build games or content packs in a limited time
- Learn from each other
- Showcase creative ideas
Community Resources¶
For New Contributors¶
| Resource | Description |
|---|---|
| Contributing Guide | How to contribute to MAID |
| Good First Issues | Beginner-friendly issues |
| Video Tutorial Outline | Planned video tutorial series |
| First Plugin Guide | Build your first content pack |
For Content Pack Creators¶
| Resource | Description |
|---|---|
| Content Pack Overview | Understanding content packs |
| Creating Content Packs | Step-by-step creation guide |
| Plugin Checklist | Pre-submission checklist |
| maid-contrib | Official plugin repository |
For Maintainers¶
| Resource | Description |
|---|---|
| RFC Process | Proposing significant changes |
| Release Process | How releases are made |
| MAINTAINERS.md | Project governance |
Frequently Asked Questions¶
How do I get help?¶
- Check the documentation first
- Search existing issues and discussions
- If you can't find an answer, open a new discussion in the Q&A category
How do I report a bug?¶
Open a bug report on GitHub. Include:
- Steps to reproduce
- Expected vs actual behavior
- MAID version and environment info
How do I suggest a feature?¶
- Check if it's already been suggested
- Open a feature request
- For major features, consider writing an RFC
How do I share my content pack?¶
- Follow the Publishing Guide
- Complete the Plugin Checklist
- Submit to maid-contrib
How do I become a maintainer?¶
Maintainers are community members who have demonstrated:
- Consistent, high-quality contributions
- Good judgment in code review
- Alignment with project values
- Reliability and follow-through
If you're interested, keep contributing and express your interest to current maintainers.
Stay Updated¶
Changelog¶
Track project changes in our Changelog.
Blog¶
Coming soon!
We'll be publishing:
- Release announcements
- Tutorials and guides
- Contributor spotlights
- Project updates
Newsletter¶
Coming soon!
Subscribe to receive monthly updates about MAID development, community highlights, and featured content packs.
Contact¶
General Inquiries¶
For general questions, use GitHub Discussions.
Security Issues¶
For security vulnerabilities, please see our Security Policy. Do not open public issues for security concerns.
Maintainers¶
See MAINTAINERS.md for a list of project maintainers.
Thank You!¶
Thank you for being part of the MAID community. Whether you're using MAID to build games, contributing code, writing documentation, or helping others - you're helping to advance text-based gaming into the future.
We can't wait to see what you build!