trezy/debug-game

Trezy

Hi, I'm Trezy (he/him)! 👋🏻 I was born in Texas, grew up in Kentucky, and moved to Wisconsin around 2009. I enjoy nerding out about Universal Basic Income, robots/automation, and Rocket League. 🚀🚗

I'm an open source software engineer working on building software that makes other developers' lives easier. I've worked on some pretty big projects, like NES.css and Backbone.Marionette. Currently I'm working on...

Project	Description
next-safe	A library for adding secure headers to your Next.js app
react-color-mode	A library for adding support for dark/light mode to your React.js app
fdgt	A staging API for building things on Twitch
B-Frame	A framework for building Node.js chat bots

Fun facts

1. I'm on IMDb.
2. I used to be a professional drummer.

Get in touch

• Twitch: https://twitch.tv/TrezyCodes
• Twitter: https://twitter.com/TrezyCodes
• Personal site: https://trezy.com/
• Instagram that I never post to: https://instagram.com/TrezyCodes

debug-game's Issues

Allow user to add RAM usage to the debugging panel

Acceptance Criteria

• A "Show RAM usage" option exists in the "System" settings
• The "Show RAM usage" option is hidden if "Show debugging panel" not enabled
• If "Show RAM usage" is enabled, the RAM usage is displayed in the debugging panel

Prerequisites

• Blocked by #17

Allow user to add framerate to the debugging panel

Acceptance Criteria

• A "Show framerate" option exists in the "System" settings
• The "Show framerate" option is hidden if "Show debugging panel" not enabled
• If "Show framerate" is enabled, the framerate is displayed in the debugging panel

Prerequisites

• Blocked by #17

Allow user to add CPU usage to the debugging panel

Acceptance Criteria

• A "Show CPU usage" option exists in the "System" settings
• The "Show CPU usage" option is hidden if "Show debugging panel" not enabled
• If "Show CPU usage" is enabled, the CPU usage is displayed in the debugging panel

Prerequisites

• Blocked by #17

Allow user to change the display resolution

Acceptance Criteria

• A "Display Resolution" setting exists in the "Graphics" settings
• A list of resolutions supported by the monitor is available
• When clicking the "Apply Settings" button, the game resolution is immediately updated

Allow user to change the music volume level

Acceptance Criteria

• A "Music Volume" option exists in the "Sound" settings
• A slider exists (1-100)
• When adjusting the slider, the music volume is updated in realtime
• If the user tries to leave the screen without clicking the "Apply Settings" button, a confirmation dialog is displayed warning that the volumes will be restored to their previous levels

Add support for direct NDI streaming

Acceptance Criteria

• An "Enable NDI Broadcast" option exists in the "Streaming" settings
• If "Enable NDI Broadcast" is enabled, the game will broadcast an NDI stream at all times
• When clicking the "Apply Settings" button, the NDI broadcast begins immediately

Prerequisites

• Blocked by #9

Other Notes

• ndi.js looks like a good candidate for this

Add Streaming section to settings

Acceptance Criteria

• A section of the settings exists for organising livestreaming settings

Implement level select scene

Acceptance Criteria

• Displays a list of all unlocked maps
• Each map displays...
  • Best time/score
  • Basic rating (star rating, maybe?)
  • Completed/Available objectives
• When clicking on a map...
  • Sets the current map in the store
  • Opens a Game scene

Allow user to add GPU usage to the debugging panel

Acceptance Criteria

• A "Show GPU usage" option exists in the "System" settings
• The "Show GPU usage" option is hidden if "Show debugging panel" not enabled
• If "Show GPU usage" is enabled, the GPU usage is displayed in the debugging panel

Prerequisites

• Blocked by #17

Allow user to enable the debugging panel

Acceptance Criteria

• A "Show debugging panel" option exists in the "System" settings
• If "Show debugging panel," the debugging panel is displayed when rendering the main game.

Prerequisites

• Blocked by #16

Allow user to change the refresh rate

Acceptance Criteria

• A "Refresh Rate" option exists in the "Graphics" settings
• A list of refresh rates supported by the monitor is available
• When clicking the "Apply Settings" button, the refresh rate is immediately updated

Allow user to add VRAM temperature to the debugging panel

Acceptance Criteria

• A "Show VRAM temperature" option exists in the "System" settings
• The "Show VRAM temperature" option is hidden if "Show debugging panel" not enabled
• If "Show VRAM temperature" is enabled, the VRAM temperature is displayed in the debugging panel

Prerequisites

• Blocked by #17

Allow user to add GPU temperature to the debugging panel

Acceptance Criteria

• A "Show GPU temperature" option exists in the "System" settings
• The "Show GPU temperature" option is hidden if "Show debugging panel" not enabled
• If "Show GPU temperature" is enabled, the GPU temperature is displayed in the debugging panel

Prerequisites

• Blocked by #17

Implement game saves

Acceptance Criteria

• Player can start a new game
• Player can load a saved game
• Player can delete a saved game
• Player can continue their most recently played game

Notes

• Saves should be local to the browser for now
• Saves should be able to be renamed
• Saves should track the following:
  • Player's unlocked maps (list of IDs)
  • Player's fastest time/highest score for each map

Allow user to change the main volume level

Acceptance Criteria

• A "Main Volume" option exists in the "Sound" settings
• A slider exists (1-100)
• When adjusting the slider, the main volume is updated in realtime
• If the user tries to leave the screen without clicking the "Apply Settings" button, a confirmation dialog is displayed warning that the volumes will be restored to their previous levels

Allow user to change the pixel scale

Acceptance Criteria

• A "Pixel Scale" setting exists in the "Graphics" settings
• A list of pixel scales (1x - 10x?) is available
• When clicking the "Apply Settings" button, the pixel scale is immediately updated

Allow user to add a clock to the debugging panel

Acceptance Criteria

• A "Show clock" option exists in the "System" settings
• The "Show clock" option is hidden if "Show debugging panel" not enabled
• If "Show clock" is enabled, the clock is displayed in the debugging panel

Prerequisites

• Blocked by #17

Implement game renderer

Acceptance Criteria

• Kicks in on game scene
• Renders current map to canvas
• Fills the centre panel of the game scene
• Resizes with the browser
• Has an adjustable camera

Allow user to update keybindings

Acceptance Criteria

• The "Controls" settings displays a dropdown listing all connected control devices (including mouse/keyboard)
• When a control device is selected...
  • Its template image is displayed
  • Its current bindings are displayed
• When a control input is activated, its reflected in the template
• When a binding is selected, a popup is displayed telling the user that its waiting for the new binding to be pressed
  • When a new binding is pressed, the popup disappears and the binding is updated
• If the user tries to leave the screen without clicking the "Apply Settings" button, a confirmation dialog is displayed warning that the all new bindings will be reset to their previous state

Allow user to add CPU temperature to the debugging panel

Acceptance Criteria

• A "Show CPU temperature" option exists in the "System" settings
• The "Show CPU temperature" option is hidden if "Show debugging panel" not enabled
• If "Show CPU temperature" is enabled, the CPU temperature is displayed in the debugging panel

Prerequisites

• Blocked by #17

Allow players to connect their Twitch account

Acceptance Criteria

• A "Twitch" section exists in the "Streaming" settings
• A "Connect to Twitch" button exists
• Clicking the button allows the user to login to their Twitch account and allow the game to use their account to access Twitch resources
• If the user has already connected their Twitch account...
  • Their Twitch avatar and username are displayed
  • A button exists to disconnect the Twitch account

Prerequisites

• Blocked by #9

Allow Twitch viewers to choose the next map

Acceptance Criteria

• An "Allow Map Voting" option exists under "Twitch" in the "Streaming" settings
• When "Allow map voting" is enabled...
  • When starting the game it will validate that the appropriate channel points rewards exist; if not, it will create them
  • Clicking the "Apply Settings" button, channel points rewards are created on the channel to support voting
• When "Allow map voting" is not enabled and the "Apply Settings" button is clicked, channel points rewards are removed from the channel

Prerequisites

• Blocked by #9

Implement game scene

Acceptance Criteria

• Left panel displays...
  • level name
  • main objectives
  • bonus objectives
  • reset and quit buttons
• Center panel is empty
• Right panel displays timer and upcoming tiles

Add Streaming section to settings

Acceptance Criteria

• A section of the settings exists for organising system settings

Add Steamworks support

Acceptance Criteria

• ?

Other Notes

• steamworks.js seems like a good candidate for this

Allow user to add VRAM usage to the debugging panel

Acceptance Criteria

• A "Show VRAM usage" option exists in the "System" settings
• The "Show VRAM usage" option is hidden if "Show debugging panel" not enabled
• If "Show VRAM usage" is enabled, the VRAM usage is displayed in the debugging panel

Prerequisites

• Blocked by #17

Allow user to change the sound effects volume level

Acceptance Criteria

• A "Sound Effects Volume" option exists in the "Sound" settings
• A slider exists (1-100)
• When adjusting the slider, the sound effects volume is updated in realtime
• If the user tries to leave the screen without clicking the "Apply Settings" button, a confirmation dialog is displayed warning that the volumes will be restored to their previous levels

Allow user to add battery status to the debugging panel

Acceptance Criteria

• A "Show battery status" option exists in the "System" settings
• The "Show battery status" option is hidden if "Show debugging panel" not enabled
• If "Show battery status" is enabled, the the battery status is displayed in the debugging panel

Prerequisites

• Blocked by #17