Pool App Help Guide

This guide explains the features available based on your user role.

Read-Only Users

As a Read-Only user, your primary function is to view past pool night data.

  • Pool Night History (Index Page): You can see the list of all recorded game nights, grouped by season.
  • View Details: Click on a game date in the history to view the detailed results, set summaries, and player scores for that specific night.
  • Theme Toggle: You can switch between light and dark themes using the toggle button in the menu.

Limitations: You cannot create, edit, delete, or lock any game nights, players, seasons, or users.

Contributor Users

As a Contributor, you can do everything a Read-Only user can, plus manage game nights you create and manage player information.

  • All Read-Only Actions: View history, view details, toggle theme.
  • Create New Pool Nights: Use the "New Pool Night" link to set up the details for a new game night (date, host, players, etc.). You will be the creator of this night.
  • Enter Game Results: For game nights you created that are not locked, you can enter the results (0 or 1) and special conditions (scratch, 8-ball run, etc.) for each game played. Use the "Game X Result" section on the detail page.
  • Edit Game Night Details: For game nights you created that are not locked, you can edit the header information (date, host, players, notes) using the "Edit Game Night Details" button on the detail page.
  • Lock Game Nights: For game nights you created, once all game results have been entered, you can use the "Lock Game Night" button. Once locked, only an Admin can edit it.
  • Delete Game Nights: For game nights you created that are not locked, you can delete the entire game night and all its results using the "Delete" action on the history page (use with caution!).
  • Manage Players: Use the "Player Management" link to add new players or edit existing player information (name, dates, host status, notes).

Limitations: You cannot edit or delete game nights created by other users. You cannot edit or delete game nights (even your own) once they are locked. You cannot manage Users or Seasons.

Admin Users

As an Admin, you have full control over all aspects of the application.

  • All Contributor Actions: Create nights, enter results, manage players.
  • Manage ALL Game Nights: You can edit or delete any game night, regardless of who created it or whether it is locked.
  • Lock/Unlock Game Nights: You can lock any game night (once results are complete). While there isn't an explicit "Unlock" button, your ability to edit locked nights effectively serves as an unlock function.
  • Manage Seasons: Use the "Season Management" link to view and rename existing seasons across all records.
  • Manage Users: Use the "User Management" link to:
    • Add new users with 'Contributor' or 'Read-Only' roles.
    • Edit existing users (username, role, password).
    • Delete users (except your own admin account).

Note: Be careful when editing or deleting users, especially other admins.