Get help with S.A.K. Utility and report a bug

Find S.A.K. Utility help through the Help and Support tab, the wiki, Discord, and GitHub bug reports, and learn what details a good report needs.

To get help with S.A.K. Utility, open the Help and Support tab. It has buttons to open this wiki, join the Discord server, report a bug, and request a feature. For a bug report, include your version number from the About tab, your Windows version, the steps that cause the problem, and any log output.

When to use this

  • Something does not work, and the guides here did not solve it.
  • You have an idea for a new feature.
  • You want to ask other users a question.

What you need

  • An internet connection. Each button opens a page in your web browser.
  • A free GitHub account to send a bug report or feature request.
  • A Discord account to join the Discord server.

Steps

Pick the right place

  1. Open the Help and Support tab.
  2. Press the button you need:
    • Report a Bug opens a bug report form on GitHub.
    • Request a Feature opens a feature request form on GitHub.
    • Open Help Wiki opens this wiki.
    • Join Discord opens the invite to the project's Discord server, for discussion, help, and announcements.
Help and Support tab with four cards: Feature Requests, Report a Bug, Help & Documentation, and Community
The Help and Support tab

Find your version

Open the About tab. The version and build date are under the title. The tab also has About, License, and Credits pages.

About tab showing the version and build date, with About, License, and Credits tabs below
The version number is on the About tab

Collect the log

  1. Turn on the Log switch at the bottom of a tool's tab. A separate log window opens beside the main window, showing what the tool is doing. If there is no room for it, the main window moves left to make some. A maximized window stays put, and the log opens over its right side, where you can drag it away.
  2. Do whatever causes the problem.
  3. Copy the lines around the error. Clear empties the window first, if that makes it easier. If you scroll up, a Jump to newest button appears beside Clear and takes you back to the latest line.
Log window with lines of operation messages and a Clear button
The log window shows what a tool is doing

If the log window is no help, look in the data folder beside the program:

  • data\logs holds the app's log files.
  • data\crashes holds crash records. Each has a .txt summary and a .dmp file, which is a snapshot of the app when it crashed.

Write the report

The bug report form asks for:

  1. Bug Description: what went wrong.
  2. Steps to Reproduce: exactly what to click, in order.
  3. Expected Behavior and Actual Behavior.
  4. S.A.K. Utility Version, from the About tab.
  5. Operating System, your Windows version.
  6. Log Output, pasted from the log window.
  7. Screenshots, if they help.

GitHub issues are public. Before you post, remove names, addresses, file paths, network names, and anything else private from your logs and screenshots. Never post an API key or a password. A crash .dmp file can hold private data from memory, so do not attach one to a public issue. Say that you have one instead.

How it works

Report a Bug and Request a Feature open forms on the project's GitHub page in your browser. S.A.K. Utility sends nothing by itself. It does not upload your logs or crash records, and you decide what to include.

Good to know

  • Search the existing issues first. Someone may have already reported your problem, and there may be a fix.
  • If the app will not open at all, you can still use the links here, and the GitHub issues page, in a browser.
  • S.A.K. Utility is a free, open project. Help comes from the project and its community, with no guaranteed response time.