> For the complete documentation index, see [llms.txt](https://yams.yassrobotics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://yams.yassrobotics.com/documentation/readme.md).

# Welcome

Welcome to the Yet Another Mechanism System (YAMS) documentation.

<figure><img src="https://1354553280-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZM0CFmYiQzcrY4zDcTtZ%2Fuploads%2FvgmqC89Zxh6rR44L755F%2FYAMS.png?alt=media&amp;token=88e9bba1-74d6-41fa-81dc-646154d61cc3" alt="The YAMS logo"><figcaption></figcaption></figure>

YAMS fuses simulation and real control as closely as possible to real life. You can debug and program your robot without the actual robot. You can also program your robot before it is built.

YAMS targets WPILib 2027 (`2027_alpha7`) and the SystemCore. Upgrading a 2026 project? See [Upgrading from 2026 to 2027](https://yams.yassrobotics.com/documentation/upgrading/upgrading-from-2026-to-2027.md).

### Start here

These docs are written for FRC student programmers. You should know some Java (or C++) and have used a WPILib [command-based](https://docs.wpilib.org/en/stable/docs/software/commandbased/index.html) project. You don't need to know PID or feedforward yet: the tutorials teach what you need as you go.

{% hint style="success" %}
**New to YAMS?** Start with [Create a project and install YAMS](https://yams.yassrobotics.com/documentation/tutorials/project-setup.md), then follow the [Arm](https://yams.yassrobotics.com/documentation/tutorials/arm.md) tutorial from start to finish.
{% endhint %}

The arm tutorial takes you the whole way:

1. [Create a project and install YAMS](https://yams.yassrobotics.com/documentation/tutorials/project-setup.md)
2. [Configure the motor controller](https://yams.yassrobotics.com/documentation/tutorials/arm/motor-controller.md), [describe the arm](https://yams.yassrobotics.com/documentation/tutorials/arm/mechanism.md) and [bind it to buttons](https://yams.yassrobotics.com/documentation/tutorials/arm/commands.md)
3. [Run it in simulation](https://yams.yassrobotics.com/documentation/tutorials/arm/simulate.md)
4. [Tune it](https://yams.yassrobotics.com/documentation/tutorials/arm/tune.md)
5. [Run it on the robot](https://yams.yassrobotics.com/documentation/tutorials/arm/robot.md)

Stuck? See [Troubleshooting](https://yams.yassrobotics.com/documentation/tutorials/troubleshooting.md).

### Installation

YAMS ships as two vendordeps, one per WPILib command framework. Install **only one** of them; they conflict with each other.

| Command framework                                 | Vendordep                                  | Online URL                                         |
| ------------------------------------------------- | ------------------------------------------ | -------------------------------------------------- |
| Commands v2 (`org.wpilib.command2`, Java and C++) | Yet Another Mechanism System (Commands v2) | `https://cdn.yassrobotics.com/yams_commands2.json` |
| Commands v3 (`org.wpilib.command3`, Java only)    | Yet Another Mechanism System (Commands v3) | `https://cdn.yassrobotics.com/yams_commands3.json` |

If you are not sure which one you need, use Commands v2. The [tutorials](https://yams.yassrobotics.com/documentation/tutorials/project-setup.md) have a tab for Java with Commands v2, Java with Commands v3, and C++.

{% tabs %}
{% tab title="Online" %}

1. In VS Code, open the command palette with <kbd>Ctrl+Shift+P</kbd> (<kbd>Cmd+Shift+P</kbd> on macOS).
2. Run **WPILib: Manage Vendor Libraries**, then **Install new libraries (online)**.
3. Paste the vendordep URL for your command framework from the table above and press Enter.
4. Install your motor controller's vendor library too, such as REVLib or Phoenix 6. YAMS drives the vendor's own motor controller objects, so it needs their library.
   {% endtab %}

{% tab title="Offline" %}

1. Install WPILib 2027 (`2027_alpha7`) first, which creates the `2027_alpha7` WPILib home folder.
2. Download `<version>-YAMS-Offline.zip` from the [YAMS GitHub releases](https://github.com/Yet-Another-Software-Suite/YAMS/releases).
3. Extract it into the WPILib home folder, so its `maven` and `vendordeps` folders merge with the existing ones:
   * **Windows:** `C:\Users\Public\wpilib\2027_alpha7`
   * **macOS and Linux:** `~/wpilib/2027_alpha7`
4. In VS Code, run **WPILib: Manage Vendor Libraries**, then **Install new libraries (offline)**, and pick **Yet Another Mechanism System (Commands v2)** or **Yet Another Mechanism System (Commands v3)**.
   {% endtab %}
   {% endtabs %}

YAMS maven artifacts are served from `https://cdn.yassrobotics.com/`.

### Get started with YAMG

The quickest way to get started is [YAMG](https://yamg.yassrobotics.com/), the Yet Another Mechanisms Generator. Fill in a form about your mechanism and it writes the code for you, ready to copy into your project.

<figure><img src="https://1354553280-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZM0CFmYiQzcrY4zDcTtZ%2Fuploads%2Fgit-blob-e10a605368e8bf8e78df5290d05e7fffe4d9c3c4%2Fyamg.png?alt=media" alt="The YAMG website, in the YASS style, generating an arm. On the left, the form: subsystem name ArmSubsystem, mechanism type Arm, Use YAMS turned on, Commands v2, and the motor configuration with a SparkMAX and a NEO. On the right, the generated ArmSubsystem.java with its SparkMax and SmartMotorControllerConfig, in tabs next to Robot.java and RobotContainer.java, with Copy, Save File, Copy Link and Download All buttons. A WPILib 2026 and WPILib 2027 toggle is at the top right."><figcaption><p>YAMG generating an arm with YAMS.</p></figcaption></figure>

1. Pick your WPILib version with the toggle at the top right: 2027, or 2026 for a 2026 project.
2. Turn on **Use YAMS**. Without it, YAMG writes code that uses only WPILib and the motor controller's vendor library.
3. Name your subsystem and pick the mechanism type: an elevator, an arm, a pivot or a flywheel.
4. Pick the command framework that matches the vendordep you installed: Commands v2 or Commands v3.
5. Fill in your motor controller, motor, gearing, limits and gains.
6. Copy each generated file into your project, or press **Download All**. Along with the mechanism, YAMG writes `Robot.java` and, for Commands v2, `RobotContainer.java` with controller bindings, or, for Commands v3, a teleop op mode.

**Copy Link** puts the whole form into a link, so you can share the mechanism with your team or come back to it later.

The tutorials below build the same mechanisms step by step and explain each part.

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th></tr></thead><tbody><tr><td><h4><i class="fa-bolt">:bolt:</i></h4></td><td><strong>Create an Arm</strong></td><td>Create your first Arm.</td><td><a href="https://yams.yassrobotics.com/documentation/tutorials/arm.md">Arm</a></td><td></td><td></td></tr><tr><td><h4><i class="fa-leaf">:leaf:</i></h4></td><td><strong>Create an Elevator</strong></td><td>Create your first elevator.</td><td><a href="https://yams.yassrobotics.com/documentation/tutorials/elevator.md">Elevator</a></td><td></td><td></td></tr><tr><td><i class="fa-crosshairs">:crosshairs:</i></td><td><strong>Create a shooter</strong></td><td>Create your first shooter.</td><td><a href="https://yams.yassrobotics.com/documentation/tutorials/shooter-flywheels.md">Shooter/FlyWheels</a></td><td></td><td></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://yams.yassrobotics.com/documentation/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
