Skip to content

SUPPORT.md

Latest commit

 

History

History
85 lines (55 loc) · 3.29 KB

SUPPORT.md

File metadata and controls

85 lines (55 loc) · 3.29 KB

Support & Help

This repository is the central place for community support around our game-related projects.

Where support happens

Most support and Q&A happens in GitHub Discussions:

Use Discussions when you:

  • Need help troubleshooting an issue.
  • Want to ask questions about features, platforms, or settings.
  • Have general feedback or ideas you want to share.

Keep each thread focused on one topic to make it easier for others to follow.

When to open an Issue vs a Discussion

Open an Issue when you have a specific, reproducible problem or a focused request:

  • Bug report – Gameplay or UI behavior is clearly incorrect.
  • Crash report – The game crashes, freezes, or closes unexpectedly.
  • Multiplayer / online issue – Connection, matchmaking, or co-op problems.
  • Performance issue – Low FPS, stuttering, hitching, or long loads.
  • Documentation issue – Problems with docs, wiki pages, or in-game help.
  • Feature request – A well-scoped idea for a new feature or improvement.

Use a Discussion when:

  • You are not sure yet whether something is a bug or intended behavior.
  • You want to brainstorm ideas or ask open-ended questions.
  • You need back-and-forth conversation to narrow down the problem.

Information we need for crashes and multiplayer issues

For crashes and hard freezes, it helps if you include:

  • Platform (Windows, Linux, macOS, Android, iOS, Steam Deck, or other).
  • Game version or build number.
  • A short description of what you were doing when the crash happened.
  • Steps leading up to the crash, if they are reproducible.
  • Any crash logs or error messages (with personal data removed).

For multiplayer / online issues, it helps if you include:

  • Platform(s) for each player.
  • Whether each player is on Wi-Fi, Ethernet, or mobile.
  • Whether anyone is behind a strict NAT, using a VPN, or on a restricted network.
  • Clear steps to reproduce the problem (hosting, joining, region, etc.).

Labels we use

We use a consistent label set to keep issues organized:

  • bug, crash, multiplayer, performance, feature-request, documentation, question
  • triage, needs-info, confirmed, duplicate, fixed, wontfix, known-issue, high-priority

You do not need to apply labels yourself when filing an issue. Maintainers will adjust labels during triage.

How to report a good bug

For more detail, read docs/bug-reporting.md.

In summary, a good bug report includes:

  • A clear summary of what went wrong.
  • The platform you are using.
  • The game version or build number.
  • Steps to reproduce the issue from a fresh start.
  • What you expected to happen vs. what actually happened.
  • Any logs or error messages that are safe to share.

Logs and diagnostics

If you are comfortable doing so:

  • Include short, relevant snippets of logs, console output, or crash dumps.
  • Avoid sharing personal data, account credentials, or unrelated information.
  • If logs are long, consider attaching them as files or using a paste service.

Security and account issues

For anything that might impact security or player accounts, please follow the guidance in SECURITY.md instead of opening a public issue.