Skip to content

bcp:

This is a config file reference. Click for instructions.

This page is reference material which explains every setting and option for this section of an MPF yaml config file. See the instructions for config files for formatting and other details. See our guide to config file examples for more examples of real configs in action.

Valid in
machine config files YES ✅
mode config files NO 🚫

The bcp: section of your config file controls how the MPF core engine communicates with the standalone media controller.

There's a default bcp: section in the default mpfconfig.yaml system-wide defaults section that should be fine to get started, and then you can override it if needed for a specific situation:

bcp:
  connections:
    local_display:
      host: localhost
      port: 5050
      type: mpf.core.bcp.bcp_socket_client.BCPClientSocket
      required: true
      exit_on_close: true
  servers:
    url_style:
      ip: 127.0.0.1
      port: 5051
      type: mpf.core.bcp.bcp_socket_client.BCPClientSocket
  debug: false

Optional settings

The following sections are optional in the bcp: section of your config. (If you don't include them, the default will be used).

connections:

List of one (or more) values, each is a type: bcp_connection:. Defaults to empty.

The connections: section is where you can specify the connections the MPF core engine will make to standalone media controllers. MPF supports connecting to multiple media controllers simultaneously which is why you can add multiple entries here.

debug:

Single value, type: boolean (true/false). Default: false

Set this to true to see more debug messages in the log.

servers:

List of one (or more) values, each is a type: bcp_server:. Defaults to empty.

The servers: section is where you can specify bcp server instances which can be connected from other processes. For instance, this is used for the service cli. MPF supports connecting to multiple servers simultaneously which is why you can add multiple entries here.

Something missing or wrong? You can fix it!

This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?

Please help us! You can fix it yourself and be an official "open source" contributor!

It's easy! See our Beginner's guide to editing the docs.

Page navigation via the keyboard: < >

You can navigate this site via the keyboard. There are two modes:

General navigation, when search is not focused:

  • F , S , / : open search dialog
  • P , , : go to previous page
  • N , . : go to next page

While using the search function:

  • Down , Up : select next / previous result
  • Esc , Tab : close search
  • Enter : go to highlighted page in the results