mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
97d0b15f7d
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>
143 lines
4.0 KiB
Markdown
143 lines
4.0 KiB
Markdown
# WPILib Maven Artifacts
|
|
|
|
WPILib publishes its built artifacts to our Maven server for use by downstream projects. This document explains these locations, and the meanings of artifact names, classifiers, and versions.
|
|
|
|
## Repositories
|
|
We provide two repositories. These repositories are:
|
|
|
|
* (Release) https://frcmaven.wpi.edu/artifactory/release/
|
|
* (Development) https://frcmaven.wpi.edu/artifactory/development/
|
|
|
|
The release repository is where official WPILib releases are pushed.
|
|
The development repository is where development releases of every commit to [main](https://github.com/wpilibsuite/allwpilib/tree/main) is pushed.
|
|
|
|
## Artifact classifiers
|
|
We provide two base types of artifacts.
|
|
|
|
The first types are Java artifacts. These are usually published as `jar` files. Usually, the actual jar file is published with no classifier. The sources are published with the `-sources` classifier, and the javadocs are published with the `-javadoc` classifier. These artifacts are published with the base artifact name as their artifact ID, with a `-java` extension.
|
|
|
|
Example:
|
|
```
|
|
org.wpilib.wpilibj:wpilibj-java:version
|
|
```
|
|
|
|
The second types are native artifacts. These are usually published as `zip` files. The `-sources` and `-headers` classifiers contain the sources and headers respectively for the library. Each artifact also contains a classifier for each platform we publish. This platform is in the format `{os}{arch}`. The full list of supported platforms can be found in [native-utils in the Platforms nested class](https://github.com/wpilibsuite/native-utils/blob/main/src/main/java/org/wpilib/nativeutils/WPINativeUtilsExtension.java). If the library is built statically, it will have `static` appended to the classifier. Additionally, if the library was built in debug mode, `debug` will be appended to the classifier. The platform artifact only contains the binaries for a specific platform. Note that the binary artifacts never contain the headers, you always need the `-headers` classifier to get those.
|
|
|
|
If the library is Java and C++ and has a JNI component, the native artifact will have a shared library containing JNI entrypoints alongside the C++ shared library. This JNI shared library will have a `jni` suffix in the file name.
|
|
|
|
Native artifacts are published with the base artifact name as their artifact ID, with a `-cpp` extension.
|
|
|
|
Example:
|
|
```
|
|
org.wpilib.wpimath:wpimath-cpp:version:classifier@zip
|
|
org.wpilib.wpimath:wpimath-cpp:version:windowsx86-64staticdebug@zip
|
|
```
|
|
|
|
## Provided Artifacts
|
|
This repository provides the following artifacts. Below each artifact is its dependencies.
|
|
|
|
For C++, if building with static dependencies, the listed order should be the link order in your linker.
|
|
|
|
All artifacts are based at `org.wpilib.artifactname` in the repository.
|
|
|
|
* wpiutil
|
|
|
|
* wpigui
|
|
* imgui
|
|
|
|
* wpimath
|
|
* wpiutil
|
|
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* ntcore
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* glass/libglass
|
|
* wpigui
|
|
* wpimath
|
|
* wpiutil
|
|
|
|
* glass/libglassnt
|
|
* wpigui
|
|
* ntcore
|
|
* wpinet
|
|
* wpimath
|
|
* wpiutil
|
|
|
|
* hal
|
|
* ntcore
|
|
* wpiutil
|
|
|
|
* halsim
|
|
* libglassnt
|
|
* libglass
|
|
* ntcore
|
|
* wpimath
|
|
* wpigui
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* cscore
|
|
* opencv
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* cameraserver
|
|
* ntcore
|
|
* cscore
|
|
* opencv
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* wpilibj
|
|
* hal
|
|
* cameraserver
|
|
* ntcore
|
|
* cscore
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* wpilibc
|
|
* hal
|
|
* cameraserver
|
|
* ntcore
|
|
* cscore
|
|
* wpimath
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* commandsv2
|
|
* wpilibc
|
|
* hal
|
|
* cameraserver
|
|
* ntcore
|
|
* cscore
|
|
* wpimath
|
|
* wpinet
|
|
* wpiutil
|
|
|
|
* wpiunits
|
|
|
|
* apriltag
|
|
* wpiutil
|
|
* wpimath
|
|
|
|
### Third Party Artifacts
|
|
|
|
This repository provides the builds of the following third party software:
|
|
|
|
* googletest
|
|
* imgui
|
|
|
|
Other software can be found in their corresponding GitHub repositories:
|
|
|
|
* ceres: https://github.com/wpilibsuite/thirdparty-ceres
|
|
* gtsam: https://github.com/wpilibsuite/thirdparty-gtsam
|
|
* opencv: https://github.com/wpilibsuite/thirdparty-opencv
|
|
* libssh: https://github.com/wpilibsuite/thirdparty-libssh
|
|
|
|
All artifacts are based at `org.wpilib.thirdparty` in the repository.
|