mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-19 00:41:43 +00:00

Files

Gold856 97d0b15f7d Add README files for some subprojects and update various other docs (#8640 )

Adds a section on design philosophy so we have something to point to
when people suggest features that aren't compatible with the way WPILib
is designed. Fixes some missed reorg changes (although the native-utils
link intentionally points to main as to be up-to-date in the future) and
generally cleans up any outdated information. Also includes wording
about supporting FTC. Per discussion in Slack, the LabVIEW wording has
been removed, and anything to do with LabVIEW is going to have to be
NI's job. And pursuant to #2757 and #5331, additional (light) developer
documentation has been added to some subprojects, mostly being a quick
summary of the what the project does and what it's for (or not for).

---------

Co-authored-by: sciencewhiz <sciencewhiz@users.noreply.github.com>
Co-authored-by: Joseph Eng <91924258+KangarooKoala@users.noreply.github.com>

2026-04-26 16:39:26 -07:00

2.3 KiB

Raw Blame History

fields

The library where FIRST field images and their metadata are stored for use by other programs.

Adding new field images

Adding the image

Field images, if stored in PNG format, should be compressed with oxipng using oxipng -o max --fast --strip safe -z fieldImage.png to ensure the image is as small as possible. They should then be placed in src/main/native/resources/org/wpilib/fields/<program>, with the name YEAR-gamename, with <program> being either ftc or frc. For FTC, the year is a pair of years, like 2025-2026.

Adding the JSON

A JSON file with the same name should also be placed in the same location, with 6 fields:

game, which should be the name of the game
field-image, which contains the path of the field image relative to the directory containing the JSON file
field-corners, an object that contains the two fields top-left and bottom-right, which are pairs of XY coordinates specifying the boundaries of the field in pixels
field-size, which is a pair of lengths in the X and Y axes, respectively
field-unit, the unit for field-size (always "foot")
program, which is either ftc or frc

X is 0 at the left edge and increases to the right, and Y is 0 at the top edge and increases going down.

Java updates

Add a new enum value to src/main/java/org/wpilib/fields/Fields.java. The enum value will be the path to the field JSON relative to the base resource directory stored in the enum.

C++ updates

Create a new header in src/main/native/include/wpi/fields/<progam> called YEAR-gamename.hpp, and fill in this template with the year and game name.

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.

#pragma once

#include <string_view>

namespace wpi::fields {
std::string_view GetResource_<YEAR>_<gamename>_json();
std::string_view GetResource_<YEAR>_<gamename>_png();
}  // namespace wpi::fields

For FTC, <YEAR> should have the dash replaced with an underscore.

Finally, add the new field to the to the list of fields in src/main/native/cpp/fields.cpp, including the newly added header and using the functions inside.

2.3 KiB Raw Blame History