> For the complete documentation index, see [llms.txt](https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/getting-started/bug-reports.md). # Bug reports The Esc menu has a **Report a bug** form, for StoneForge itself and for any C# mod that asks for reports. ## Reporting a bug Open the Esc menu in a game and choose **Report a bug**. Pick StoneForge or a mod, then write a title (5 to 120 characters) and a description of what happened, what you expected and how to make it happen again (20 to 4000 characters; several lines, with paste, selection and scrolling). You can include the last StoneForge console messages: up to 50 lines, 512 characters each, 8 KiB in all. The report goes to the project's GitHub repository through the BugDrop service, with StoneForge's and the mod's versions, Windows' version, the game's language and the window size. Screenshots and attachments aren't sent. If sending fails, your draft is kept. If StoneForge can't tell whether a report arrived, check the repository's issues before sending it again. To keep reports from becoming spam, StoneForge limits how often you can send: * one report at a time, and 10 minutes between them; * 3 an hour and 10 a day; * the same title and description to the same project only once a day. A report the service turned down (an HTTP error such as 404) can be sent again after the 10 minutes, once corrected. Failed attempts count too, and nothing is retried automatically. The limits are kept in `dotnet\report-limits.json` as hashes and times: your report's text isn't saved there. ## Taking reports for your mod Add your mod's GitHub repository to its `mod.json`: ```json "github": "YourAccount/YourMod" ``` A URL such as `https://github.com/YourAccount/YourMod` works too. The form then lists your mod while it's running. StoneForge only checks how the repository is written. For reports to arrive, the repository must exist and be set up to receive them through BugDrop. To install BugDrop into your repository add it through the GitHub marketplace here (It is free) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/getting-started/bug-reports.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.