Settings

Currently, the House Cup allows admins to customize the following settings, available under the settings tab in the admin panel:

General Settings

• grades: List of all grades the school has. Should also include "other" for administrators/other staff.
• house-term: Term for what a "house" is called at your school, as some school do not call them houses. Can be any string, and should be capitalized. Defaults to "House" if not set.
• track-student-points: This setting enables you to track what students are earning points. By default, the House Cup system only tracks what house is getting points, not what student earned the points. This turns it on. Must be "true" or "false". Defaults to false.
• require-student-points: Whether selecting a student is required to submit points. If this is disabled, and track-student-points is true, you can give points both to a house, and to a specific student. Must be "true" or "false". Defaults to false.
• recalculate-scores-nightly: Whether to recalculate the scores nightly. This dumps the current score for each house, and recalculates it based on the Point Assignments. Useful for making deleting point assignments easier as that night it will update the points. Must be "true" or "false". Defaults to false
• recalculate-points-since: In combination with recalculate-scores-nightly, this setting determines how far back to look at the point assignments when recalculating the scores. Must be a date in the format mm/dd/yy, such as 11/11/11. Defaults to all available point assignments if not set.

Theming Settings

• navbar-background-color: This is the color of the top bar. Must be a Hex color value.
• navbar-foreground-color: This is the color of the text on the top bar. Must be a Hex color value.
• background-color: This is the color of the background in the main body area. Must be a Hex color value.
• text-color: This is the color of the text. Must be a Hex color value. It's recommended to only set this to white (#FFFFFF) or black (#000000) so it is easy to read.
• button-color: Sets the colors for buttons on the site. Must be a Hex color value.

Rate Limiting Settings

• rate-limit: Whether to enable the rate limiting feature and only allow a certain number of points to be allocated during a given time period by a staff member. must be either "true" or "false". True enables the feature
• rate-limit-max-positive-points: The maximum amount of points a staff can add in the given time. Must be a whole number
• rate-limit-max-negative-points: The maximum amount of points a staff can remove in the given time. Must be a whole number
• rate-limit-positive-reset-minutes: How long to look back when seeking out the max points to rate limit for added points. So you can say a max of 50 points in 10 minutes. Must be a whole number.
• rate-limit-negative-reset-minutes: How long to look back when seeking out the max points to rate limit for added points. So you can say a max of 50 points in 10 minutes. Must be a whole number.

View Customization Settings

• show-house-text-names: Whether to show the text name of a house under it's logo. Must be "true" or "false", defaults to false.
• show-note-section: Whether to show a text area for staff to enter notes about why they are giving out points. Must be "true" or "false". Defaults to false
• note-required: Whether a note is required to be entered in order to give out points. Must be "true" or "false". Defaults to false.
• custom-points: Whether to allow staff to enter custom points. These must still adhere to the point limits. Must be "true" or "false". Defaults to false
• multiple-assignments: Whether to allow staff to assign the same activity multiple times. This submits the same activity one after the other automatically, so that the staff doesn't have to re-enter the same thing multiple times. Must be "true" or "false". Defaults to false.