@foothold/foothold-cli

Installation

npm install -g @foothold/foothold-cli

Environment

export FH_ENV=local || dev || stg || prd

Authentication

export FH_GITHUB_TOKEN=personal_access_token_generated_from_github

Commands

foothold deploy

foothold.yml

# Access environment variables through ${env:VARIABLE_NAME}

license:
  key: "1234567890"

game:
  name: "Game Name"
  description: "Description of the game"
  google_package_name: "google_package_name"
  apple_package_name: "apple_package_name"
  google_play_link: "google_play_link"
  app_store_link: "app_store_link"

authentication:
  - "guest"
  - "facebook"
  - "google"

builds:
  default:
    configuration:
      key1: "value1"
      key2: "value2"
      key3: "value3"
  build_slug:
    name: "Build Name"
    configuration:
      key1: "value1"
      key2: "value2"
      key3: "value3"

read_only_stats:
  - "read_only_stat_1"
  - "read_only_stat_1"
  - "read_only_stat_1"

scripts:
  script_slug:
    name: "Script Name"
    type: "event || lobby_start || lobby_message || lobby_end"
    description: "Script description"
    file: "path/to/script.js"
    versions:
      build_slug:
        file: "path/to/script/version.js"
        description: "Script description"

events:
  event_slug:
    name: "Event Name"
    description: "Event description"
    script: "script_slug"

virtual_goods:
  virtual_good_slug:
    name: "Virtual Good Name"
    type: "virtual_good_type"
    description: "Virtual good description"
    stackable: false
    can_be_pushed: false
    can_be_pulled: false
    data:
      key1: "value1"
      key2: "value2"
      key3: "value3"

currencies:
  currency_slug:
    name: "Currency Name"
    description: "Currency description"

bundles:
  bundle_sku:
    name: "Bundle Name"
    type: "bundle_type"
    description: "Bundle description"
    currencies:
      currency_slug:
        min: 1
        max: 10
    virtual_goods:
      virtual_good_slug:
        min: 1
        max: 10
    is_iap: true
    google_product_name: "google_product_name"
    apple_product_name: "apple_product_name"
    price: 7.50
    discounted_price: 5.25
    discounted_from: "MM-DD-YYYY"
    discounted_to: "MM-DD-YYYY"

achievements:
  achievement_slug:
    name: "Achievement Name"
    points: 10
    description: "Achievement description"

leaderboards:
  achievement_slug:
    name: "Leaderboard Name"
    source: "currency_slug"
    start: "MM-DD-YYYY"
    end: "MM-DD-YYYY"
    description: "Leaderboard description"

assets:
  asset_slug:
    name: "Asset Name"
    type: "asset_type"
    description: "Asset description"
    file: "path/to/asset.jpg"
    versions:
      build_slug:
        file: "path/to/asset.jpg"
        description: "Asset description"

dlcs:
  dlc_slug:
    name: "DLC Name"
    type: "dlc_type"
    description: "DLC description"
    file: "path/to/dlc.zip"
    data:
      key1: "value1"
      key2: "value2"
      key3: "value3"
    versions:
      build_slug:
        file: "path/to/dlc.zip"
        description: "DLC description"
        data:
          key1: "value1"
          key2: "value2"
          key3: "value3"

lobbies:
  lobby_slug:
    name: "Lobby Name"
    min_players: 2
    max_players: 10
    description: "Lobby Description"
    handlers:
      start: "script_slug_start"
      end: "script_slug_end"
      message:
        - "script_slug_1"
        - "script_slug_2"
        - "script_slug_3"
    data:
      key1: "value1"
      key2: "value2"
      key3: "value3"