> ## Documentation Index
> Fetch the complete documentation index at: https://transcension.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Setup Ships

> Configures the fleet for a specific team within an existing game, assigning names, types, and combat statistics to each ship.



## OpenAPI

````yaml api-reference/cubic-api.json post /api/v1/cubic/setupShips
openapi: 3.0.0
info:
  title: Cubic Game API
  description: >-
    API documentation for the Cubic game, providing endpoints for game
    management, ship actions, and retrieving game state information.
  version: '1.0'
  contact:
    name: Cubic Game Support
servers:
  - url: http://50.187.81.221:4000
    description: Rendezvous Cubic Server.
  - url: https://cubic.ngrok.app
    description: Ender's Cubic Server.
security: []
tags:
  - name: Cubic
    description: Operations related to the Cubic game mechanics.
paths:
  /api/v1/cubic/setupShips:
    post:
      tags:
        - Cubic
      summary: Setup Ships
      description: >-
        Configures the fleet for a specific team within an existing game,
        assigning names, types, and combat statistics to each ship.
      operationId: CubicController_setupShips
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TeamFleetDataDTO'
            examples:
              setupShipsExample:
                summary: Example of setting up ships for a team
                value:
                  gameID: uniqueGame123
                  teamName: RedTeam
                  ships:
                    - name: RedScout1
                      shipType: SCOUT
                      stats:
                        moveFactor: 3
                        attackFactor: 1
                        defenseFactor: 1
                        attackRange: 1
                    - name: RedDestroyer1
                      shipType: DESTROYER
                      stats:
                        moveFactor: 2
                        attackFactor: 2
                        defenseFactor: 2
                        attackRange: 1
        description: >-
          Details for setting up a team's fleet, including the game ID, team
          name, and a list of ships with their types and stats.
      responses:
        '201':
          description: Ships successfully set up for the specified team.
components:
  schemas:
    TeamFleetDataDTO:
      type: object
      properties:
        gameID:
          type: string
          description: The unique identifier of the game.
        teamName:
          type: string
          description: The name of the team to which the fleet belongs.
        ships:
          description: >-
            List of ships that belong to this team, including their names,
            types, and stats.
          type: array
          items:
            $ref: '#/components/schemas/ShipSetupDataDTO'
      required:
        - gameID
        - teamName
        - ships
      description: >-
        Data transfer object for defining the entire fleet for a specific team
        in a game.
    ShipSetupDataDTO:
      type: object
      properties:
        name:
          type: string
          description: The unique name of the ship.
        shipType:
          type: string
          enum:
            - SCOUT
            - DESTROYER
            - CRUISER
            - BATTLESHIP
          description: The type of ship, determining its base characteristics.
        stats:
          $ref: '#/components/schemas/ShipStatsDataDTO'
          description: Detailed statistics for the ship's performance.
      required:
        - name
      description: >-
        Data transfer object for setting up an individual ship within a team's
        fleet.
    ShipStatsDataDTO:
      type: object
      properties:
        moveFactor:
          type: number
          description: The number of spaces a ship can move per turn.
        attackFactor:
          type: number
          description: The offensive power of the ship, affecting damage dealt.
        defenseFactor:
          type: number
          description: The defensive capability of the ship, affecting damage taken.
        attackRange:
          type: number
          description: The maximum distance from which the ship can attack.
      required:
        - moveFactor
        - attackFactor
        - defenseFactor
        - attackRange
      description: >-
        Data transfer object defining the combat and movement statistics of a
        ship.

````