Skip to content

Main Configuration File (bpm)

The main configuration file is located at ~/.bpm/bpm and contains global settings that apply to all BPM projects on the system.

File format: TOML

[main] Section

The main section contains all global configuration parameters for BPM.

Parameters

Parameter Type Default Description
oricutron_path string "oricutron" Path to the Oricutron emulator binary
oricutron_replace_autoboot_run boolean "True" Whether to replace Oricutron's autoboot when running projects
default_rom_oricutron_for_code integer 4 Default ROM slot for code type projects (1-42 for ROM, 43+ for RAM)
bpm_version string BPM version Current BPM version (auto-updated)
last_check_update string "0000-00-00" Date of last update check
default_orixsdk_version string "" Default version of orixsdk plugin
default_asm_bin_tpl_version string "" Default version of asm_bin_tpl plugin
default_asm_rom_tpl_version string "" Default version of asm_rom_tpl plugin
default_github_action_version string "" Default version of github_action plugin
default_kernel_version string "2024.1" Default kernel version
default_generatedoc_version string "" Default version of generatedoc plugin

Parameter Details

oricutron_path

Type: string Default: "oricutron" Description: Path to the Oricutron emulator binary. This is the full path to the Oricutron executable on your system. Example:

oricutron_path = "/opt/oricutron/oricutron"

Note: This can be overridden per project in the project's bpm.tml file.

oricutron_replace_autoboot_run

Type: boolean Default: "True" Description: When set to True, BPM will replace Oricutron's autoboot configuration when running projects. Set to False to prevent this behavior. Example:

oricutron_replace_autoboot_run = "True"

default_rom_oricutron_for_code

Type: integer Default: 4 Description: Default ROM slot for code type projects. - Values 1-42: ROM slots (e.g., rom04) - Values 43+: RAM slots (e.g., ram01 for 43, ram10 for 52)

Example:

default_rom_oricutron_for_code = 4

Note: This can be overridden per project in the project's bpm.tml file.

bpm_version

Type: string Default: Current BPM version Description: The version of BPM installed. This is automatically updated by the system. Example:

bpm_version = "2026.3.0"

last_check_update

Type: string Default: "0000-00-00" Description: Date of the last update check. Updated automatically when BPM checks for updates. Example:

last_check_update = "2026-07-01"

default_orixsdk_version

Type: string Default: "" Description: Default version of the orixsdk plugin to use for new projects. This is a mandatory plugin for Orix projects as it provides useful ca65 macros for Orix and relocatable binaries. Example:

default_orixsdk_version = "2023.3.0"

Note: This can be overridden per project in the project's bpm.tml file using the orixsdk_version parameter.

default_asm_bin_tpl_version

Type: string Default: "" Description: Default version of the asm_bin_tpl (Assembly Binary Template) plugin. This template provides a structure for creating binary executables for Orix. Example:

default_asm_bin_tpl_version = "2024.4"

default_asm_rom_tpl_version

Type: string Default: "" Description: Default version of the asm_rom_tpl (Assembly ROM Template) plugin. This template provides a structure for creating ROM cartridges for Orix. Example:

default_asm_rom_tpl_version = "2024.4"

default_github_action_version

Type: string Default: "" Description: Default version of the github_action plugin, which provides templates for GitHub Actions workflows. Example:

default_github_action_version = "2024.4"

default_kernel_version

Type: string Default: "2024.1" Description: Default kernel version to use. The kernel provides essential system calls and functionality for Orix applications. Example:

default_kernel_version = "2024.1"

Note: Individual projects can specify a minimum required kernel version using orix_minimal_kernel_version in their bpm.tml file.

default_generatedoc_version

Type: string Default: "" Description: Default version of the generatedoc plugin, which is a tool to comment source code and generate markdown documentation. Example:

default_generatedoc_version = "2025.1"

Complete Example

[main]
oricutron_path = "/opt/oricutron/oricutron"
oricutron_replace_autoboot_run = "True"
default_rom_oricutron_for_code = 4
bpm_version = "2026.3.0"
last_check_update = "2026-07-01"
default_orixsdk_version = "2023.3.0"
default_asm_bin_tpl_version = "2024.4"
default_asm_rom_tpl_version = "2024.4"
default_github_action_version = "2024.4"
default_kernel_version = "2024.1"
default_generatedoc_version = "2025.1"

Configuration Management

You can manage the main configuration file using the bpm config command:

Setting Main Configuration Parameters

# Set Oricutron path
bpm config set main oricutron_path /usr/local/bin/oricutron

# Disable autoboot replacement
bpm config set main oricutron_replace_autoboot_run False

# Set default ROM slot
bpm config set main default_rom_oricutron_for_code 5

# Set default orixsdk version
bpm config set main default_orixsdk_version 2023.3.0

# Set default kernel version
bpm config set main default_kernel_version 2024.1

File Location

The main configuration file is stored at: - Linux/macOS: ~/.bpm/bpm - Windows: %USERPROFILE%\.bpm\bpm

If this file does not exist, BPM will create it with default values on first run.

See Also