Bug Reporting - Hawthorn-Games/ProjectScrapped GitHub Wiki

Testing Guide

This is the Test Kit from Hawthorn Games to aid in the testing of Project Scrapped. Below you will find a small list of items that are currently in development to help guide your bug logging and suggestions for improvements for the future, as well as a section detailing the areas of focus we would appreciate being given extra attention so as to make the best use of your time. We have also included a handy bug reporting guide that includes a template you are welcome to use to help log any bugs you find and how best to categorise them into types. At the bottom of the kit you can find a link to the feedback form where we are gathering qualitative feedback and any comments and suggestions you would like to provide.

Currently in Development

This sections helps to serve as a look into what we are working on to better guide any suggestions or improvements. If you have any ideas or suggested approaches to these specific areas we would love to hear them.

  • Beginning Tutorial
  • Contextual Hint System
  • Additional Gameplay Elements - For use in Puzzles
  • Efficiency system - Encourages efficient use of code in Puzzles
  • Reward Ceramony for finishing Puzzles
  • General UX Improvements
  • Dynamic Soundtrack & Sound Effects

Preferred Area's of Focus

This sections helps to serve as a look into what we would like the most feedback on and areas that require the most work to help better focus feedback. You do not need to adhere to them, any bugs or suggestions outside of these areas are just as useful, they are simply areas we have found to be the most troublesome.

  • Logic Editing Core Mechanic
    • Usability
    • User Experience - How does it feel? Is it confusing? Is vital information obscure?
    • General suggestions for improvements
    • Any bugs found
  • Puzzle Elements
    • Golems
    • Crates/Pushable Pullable objects
    • Buttons
    • Colour Switchers (Currently undergoing a rework - To be implemented in next build)
  • Puzzle Difficulty
    • Clarity of possible actions within a puzzle
    • Difficulty curve - Too steep? Too easy?

Bug Reporting Guide

Bug Reporting Template

[Version] [Severity] [Tags (e.g Golems, Buttons, UI etc)] Title

Description

A detailed description of the bug

Steps to Reproduce

The exact same steps that the developer needs to take to reproduce the bug

Expected Result

What should happen when those steps are taken?

Actual Result

What is the actual, unexpected result?

Attachments

Any useful link relative to gameplay footage that clearly shows the bug

Example Bug Report

! !

Types

  • A | Crash – A crash bug is a bug that causes the game to stop working completely. This is usually caused by a problem in the programming and can be caused by any number of things (e.g. playable characters touching certain parts of the environment or when interacting with certain objects)

  • B | Severe – A severe bug is a bug that stops game (or story) progression but does not stop the player’s ability to play the game. This is most commonly seen in games that rely on NPC interaction for story progression and can be caused by stopping the player from being able to interact with certain NPCs or simply removes them from the game.

  • C | General – A general bug is one that doesn’t stop a player’s progression through the game but causes a problem that more than anything breaks the ‘immersion’ of a player. The most common examples of general bugs is usually seen in the form of objects and NPCs ‘clipping’ through other objects or NPCs (e.g. when interacting with a door that is meant to slide up to open it slides to the right and through the wall instead)

  • D | Minor – A minor bug is a bug that does not cause too much of a problem with playing the game itself but may annoy the player. A common example are small processing problems such as missing frames of animation on NPCs or the surrounding area (another common example is miscellaneous objects despawning or spawning somewhere they aren’t programmed to)

  • E | Cosmetic – A cosmetic bug is one caused purely as one that the player can see, it does not disrupt gameplay or stop progression. This can be seen in textures if the right one doesn’t load or if there is a delay in the texture loading (this may also occur when a player’s view pans over certain objects which would seem to flicker in and out of existence)

Feedback Form

Here is the Feedback Form with a series of questions to help us gather testing data on our game.

⚠️ **GitHub.com Fallback** ⚠️