Skip to content

App Configuration

Liam Fruzyna edited this page Jan 27, 2024 · 1 revision

Various settings can be managed from either the config/config.json file or the settings page in the web app which is automatically generated from the JSON file.

Settings

Various app-wide settings.

ID Value Default Description
title string WildRank The title of the app displayed at the top of every page.
time_format 12/24 24 Toggle the apps time format between 12 or 24 hour time.
use_images boolean true Toggle use of robot images across the app.

Defaults

Default values for home page configurations.

ID Value Default Description
event_id TBA key 2020ilch The default blue alliance event id.
upload_url url http://localhost The default upload url.
user_id integer 715138 The default user id.

Coach Vals

List of objects describing coach view values.

ID Value Description
function mean/median/mode/min/max The function to use when summarizing the result.
key key The result or smart stat key summarized in the value.

Smart Stats

List of objects describing automatically computed results.

ID Value Description
id key New id representing the smart stat.
name string New human readable name representing the smart stat.
type sum/percent/ratio/where The type of smart stat.

Optional Keys

ID Type Value Description
keys sum list of keys List of keys for results to sum together.
numerator percent/ratio key Key for result to use in numerator of operation.
denominator percent/ratio key Key for result to use in denominator of operation.
cycle where key Key for the cycle used to calculate the where.
conditions where map of keys and value Object representing map of result keys and the desired values.
sum where key Key of the cycle result to sum together instead of counting.

Whiteboard

Settings for the whiteboard page. These settings exist in an array for each game year.

ID Value Description
year string The year of events that the whiteboard will be used.
red/blue_i object Object representing the initialization position and color of each team position.
game_pieces list of objects Description of game pieces available to add to the field.
draw_color string hex color The color used to draw on the whiteboard (without a magnet).
field_width integer The whiteboard width in pixels.
field_height integer The whiteboard height in pixels.
magnet_size integer The width and height of a magnet in pixels.
line_width integer The width of drawn lines in pixels.
horizontal_margin integer The horiztonal width of the sidelines on the field image in pixels.
vertical_margin integer The vertical height of the sidelines on the field imge in pixels.
field_height_ft integer The height of the real field in feet.
field_height_px integer The height of the field on the map in pixels.

Positions

ID Value Description
x integer Horiztonal position on the whiteboard to initialize the team.
y integer Vertical position on the whiteboard to initialize the team.
color string hex color The color to draw on the whiteboard when dragged.

Game Pieces

ID Value Description
name string The name of a game piece.
image string file name The file name of the image used in /config.

Admins

A comma-separated list of admin user IDs.

Theme and Dark Theme

All colors across the app can be configured for both light and dark themes.

Clone this wiki locally