Programming Howto:Building BCI2000 - Revision history

Mellinger at 14:38, 10 March 2025

2025-03-10T14:38:26Z

← Older revision		Revision as of 14:38, 10 March 2025
Line 2:		Line 2:

	There are step-by-step tutorials for each:		There are step-by-step tutorials for each:
	* [[Programming Howto:Building and Customizing BCI2000]] for Windows systems,		* [[Programming Howto:Building and Customizing BCI2000\|Building and Customizing BCI2000 for Windows systems]],
	* [[Programming Howto:Non:Building and Customizing BCI2000 on Non-Windows Platforms]] for macOS and ~~Linx~~.		* [[Programming Howto:Non:Building and Customizing BCI2000 on Non-Windows Platforms\|Building and Customizing BCI2000 for macOS and Linux]].

	<!-- This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.		<!-- This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.

Mellinger at 14:37, 10 March 2025

2025-03-10T14:37:05Z

← Older revision		Revision as of 14:37, 10 March 2025
Line 1:		Line 1:
	This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.		The process of building BCI2000 from source differs between Windows and non-Windows (macOS, Linux) systems.

			There are step-by-step tutorials for each:
			* [[Programming Howto:Building and Customizing BCI2000]] for Windows systems,
			* [[Programming Howto:Non:Building and Customizing BCI2000 on Non-Windows Platforms]] for macOS and Linx.

			<!-- This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.

	==Prerequisites==		==Prerequisites==
Line 27:		Line 33:
	===6. Build BCI2000 in full, or partially===		===6. Build BCI2000 in full, or partially===
	In the IDE, choose which projects to build. You may right-click individual projects, or groups of projects, and choose "build" from the context menu.		In the IDE, choose which projects to build. You may right-click individual projects, or groups of projects, and choose "build" from the context menu.
			-->
	[[Category:Howto]][[Category:Development]]		[[Category:Howto]][[Category:Development]]

Mellinger: /* 2. If using Qt on Windows, point CMake to it */

2021-02-25T11:45:58Z

2. If using Qt on Windows, point CMake to it

← Older revision		Revision as of 11:45, 25 February 2021
Line 13:		Line 13:
	#Under Name, enter "Qt5_DIR" (case matters), and set "Type" to "PATH".		#Under Name, enter "Qt5_DIR" (case matters), and set "Type" to "PATH".
	#Under Value, enter the path to your Qt distribution's <tt>lib/cmake/Qt5</tt> directory.		#Under Value, enter the path to your Qt distribution's <tt>lib/cmake/Qt5</tt> directory.
	E.g., if your Qt distribution for MSVC ~~2015~~, 64 bit, is located under <tt>D:/Qt/5.10.1/~~msvc2015_64~~</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/~~msvc2015_64~~/lib/cmake/Qt5</tt>.		E.g., if your Qt distribution for MSVC 2019, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2019_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2019_64/lib/cmake/Qt5</tt>.

	===3. Click "Configure"===		===3. Click "Configure"===

Mellinger: /* Prerequisites */

2021-02-25T11:45:24Z

Prerequisites

← Older revision		Revision as of 11:45, 25 February 2021
Line 2:		Line 2:

	==Prerequisites==		==Prerequisites==
	#A C++ compiler. Currently, MSVC ~~2012 through~~ 2017 are supported.		#A C++ compiler. Currently, MSVC 2017 and 2019 are supported.
	~~#Support for MSVC 2015 is broken in CMake. For a fix, you will need to copy RC.EXE and RCDLL.DLL from inside one of the Windows Kits into your MSVC 2015 VC/bin directory~~.
	#To build GUI-related parts of BCI2000, a recent version of Qt5 is required. Use Qt's maintenance tool to select and install a version of Qt that matches your C++ compiler.		#To build GUI-related parts of BCI2000, a recent version of Qt5 is required. Use Qt's maintenance tool to select and install a version of Qt that matches your C++ compiler.
	#CMake 3.11 or newer. Choose "add to path for all users" when prompted by the installer.		#CMake 3.11 or newer. Choose "add to path for all users" when prompted by the installer.

Mellinger: /* Prerequisites */

2018-06-14T13:04:53Z

Prerequisites

← Older revision		Revision as of 13:04, 14 June 2018
Line 3:		Line 3:
	==Prerequisites==		==Prerequisites==
	#A C++ compiler. Currently, MSVC 2012 through 2017 are supported.		#A C++ compiler. Currently, MSVC 2012 through 2017 are supported.
			#Support for MSVC 2015 is broken in CMake. For a fix, you will need to copy RC.EXE and RCDLL.DLL from inside one of the Windows Kits into your MSVC 2015 VC/bin directory.
	#To build GUI-related parts of BCI2000, a recent version of Qt5 is required. Use Qt's maintenance tool to select and install a version of Qt that matches your C++ compiler.		#To build GUI-related parts of BCI2000, a recent version of Qt5 is required. Use Qt's maintenance tool to select and install a version of Qt that matches your C++ compiler.
	#CMake 3.11 or newer. Choose "add to path for all users" when prompted by the installer.		#CMake 3.11 or newer. Choose "add to path for all users" when prompted by the installer.

Mellinger: /* 2. If using Qt on Windows, point CMake to it */

2018-05-29T13:33:19Z

2. If using Qt on Windows, point CMake to it

← Older revision		Revision as of 13:33, 29 May 2018
Line 12:		Line 12:
	#In the CMake GUI, click "Add Entry".		#In the CMake GUI, click "Add Entry".
	#Under Name, enter "Qt5_DIR" (case matters), and set "Type" to "PATH".		#Under Name, enter "Qt5_DIR" (case matters), and set "Type" to "PATH".
	#Under Value, enter the path to your Qt distribution's "lib/cmake/Qt5" directory.		#Under Value, enter the path to your Qt distribution's <tt>lib/cmake/Qt5</tt> directory.
	E.g., if your Qt distribution for MSVC 2015, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2015_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2015_64/lib/cmake/Qt5</tt>.		E.g., if your Qt distribution for MSVC 2015, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2015_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2015_64/lib/cmake/Qt5</tt>.

	===3. Click "Configure"===		===3. Click "Configure"===
	From the list of compilers, choose the compiler that you would like to use.		From the list of compilers, choose the compiler that you would like to use.

Mellinger: /* 3. Click "Configure" */

2018-05-29T13:32:27Z

3. Click "Configure"

← Older revision		Revision as of 13:32, 29 May 2018
Line 15:		Line 15:
	E.g., if your Qt distribution for MSVC 2015, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2015_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2015_64/lib/cmake/Qt5</tt>.		E.g., if your Qt distribution for MSVC 2015, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2015_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2015_64/lib/cmake/Qt5</tt>.
	===3. Click "Configure"===		===3. Click "Configure"===
	From the list of compilers, choose the compiler that ~~matches~~ the Qt distribution chosen above.		From the list of compilers, choose the compiler that you would like to use.
			If using Qt, the compiler must match the Qt distribution chosen above.

	===4. Choose build options===		===4. Choose build options===
	#Make sure that "Grouped" is checked in the GUI, and "Advanced" is unchecked.		#Make sure that "Grouped" is checked in the GUI, and "Advanced" is unchecked.

Mellinger at 15:10, 28 May 2018

2018-05-28T15:10:56Z

← Older revision		Revision as of 15:10, 28 May 2018
Line 1:		Line 1:
	~~#REDIRECT [[Programming Reference:Build System]]~~

	This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.		This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.

	== ~~Why to build~~ ==		==Prerequisites==
	~~Typically, you will install BCI2000 from its [[BCI2000 Binaries\|binary distribution]], and do not need to build BCI2000, unless~~		#A C++ compiler. Currently, MSVC 2012 through 2017 are supported.
	*you want to always use its most current SVN version,		#To build GUI-related parts of BCI2000, a recent version of Qt5 is required. Use Qt's maintenance tool to select and install a version of Qt that matches your C++ compiler.
	*you create your own module by modifying an existing one,		#CMake 3.11 or newer. Choose "add to path for all users" when prompted by the installer.
	*you create a new module from scratch.

	~~== Tools required ==~~
	~~As of BCI2000 version 2.0, building all~~ parts of BCI2000 ~~requires Borland's C++ Builder 6~~, or a ~~more~~ recent version.
	~~The operator GUI~~ and ~~Application modules currently require the Borland VCL library.~~
	~~The following non-GUI related parts~~ of ~~BCI2000 can be built using the freely available Borland~~ C++ compiler:
	*[[User Reference:Command Line Processing\|Command line tools]]
	*[[User Reference:Matlab MEX Files\|Matlab MEX files]]

	==How to build==		==How to build==
	===~~Building BCI2000 from the command line~~===		===1. Start CMake===
	~~Command-line builds require a working installation of Borland C++ Builder 6.~~		In the BCI2000 build directory, double-click '''Configure.sh.bat'''.
	~~# Open a Windows cmd shell, e.g. by choosing "Run..." from the Start Menu and entering "cmd".~~		===2. If using Qt on Windows, point CMake to it===
	~~# Change to~~ the BCI2000 ~~"src"~~ directory.		#In the CMake GUI, click "Add Entry".
	~~# Execute "make" from the command prompt.~~		#Under Name, enter "Qt5_DIR" (case matters), and set "Type" to "PATH".
	~~# If you updated or edited any of the source files~~, ~~and experience linker errors or other unexpected behavior, execute "make clean && make all"~~.		#Under Value, enter the path to your Qt distribution's "lib/cmake/Qt5" directory.
	~~# For build versioning, execute "make build" rather than "make" or "make all"~~. ~~This will update the build information visible in the BCI2000 "Version" parameters, and in the "About" boxes of BCI2000 GUI applications~~.		E.g., if your Qt distribution for MSVC 2015, 64 bit, is located under <tt>D:/Qt/5.10.1/msvc2015_64</tt>, the "Qt5_DIR" CMake variable should point to <tt>D:/Qt/5.10.1/msvc2015_64/lib/cmake/Qt5</tt>.
			===3. Click "Configure"===
	===~~Building BCI2000~~ using ~~the Borland C++ Builder 6 IDE~~===		From the list of compilers, choose the compiler that matches the Qt distribution chosen above.
	# ~~Open~~ the ~~file~~ "~~BCI2000.bpg~~" ~~with the IDE by double-clicking it~~.		===4. Choose build options===
	# ~~Make sure the~~ "~~ProjectManager~~" ~~view is visible to the left~~ (~~choose~~ "~~Project Manager~~" ~~from the~~ "~~View~~" ~~menu to display it)~~.		#Make sure that "Grouped" is checked in the GUI, and "Advanced" is unchecked.
	# ~~Right-click~~ the ~~topmost project (located immediately below the line reading~~ "~~BCI2000~~"), ~~and choose "Make all from here"~~.		#Under the "BUILD" section, you may choose which parts of BCI2000 to build. Typically, you will want to have "BUILD_CONTRIB" checked.
	~~# To get rid of possible inconsistencies from earlier builds~~, ~~choose~~ "~~Build all from here" rather than "Make all from here~~".		#Under "EXTENSIONS", choose which extensions to include into the build.
			===5. Click "Generate"===
	===~~Starting up BCI2000~~===		A project/solution file will be created inside the BCI2000 build directory. Double-click it to open it in the IDE.
	~~# After compilation, a desired configuration of BCI2000 may be started by executing an appropriate batch file from~~ the ~~top level "batch" directory. Once a particular configuration~~ of ~~BCI2000 is started~~, ~~simply load a parameter file with~~ the ~~same name as~~ the ~~batch file from the "parms" directory~~.		===6. Build BCI2000 in full, or partially===
	~~# If you need a configuration for which no batch file exists, just modify a copy of a batch file that is close to your needs.~~		In the IDE, choose which projects to build. You may right-click individual projects, or groups of projects, and choose "build" from the context menu.

	===~~Compiling BCI2000 with Borland C++ Builder (BCB) 2006/2007/2009~~===
	~~When using BCB 2006, please make~~ sure ~~to install all available updates from~~ the ~~[http://cc.codegear.com/reg/bds Borland Download Site]. The originally shipped version of BCB 2006 is defective~~ and ~~will not work without updating. We recommend updating to BCB 2009.~~
	~~# Open the file~~ "~~BCI2000.bpg~~" ~~from within Borland Developer Studio. This will import all existing projects into BDS project files~~.
	# In the ~~project manager (at the top right), right-click the topmost project and choose~~ "~~Make all from here~~".
	~~# To get rid of possible inconsistencies from earlier builds~~, choose ~~"Build all from here" rather than "Make all from here".~~
	~~# Command-line builds cannot be done with Borland C++ Builder 2007/2009 because it lacks the bpr2mak project-~~to~~-makefile conversion utility~~. ~~Still~~, ~~[[User Reference:Command Line Processing\|Command line tools]] and [[User Reference:Matlab MEX Files\|Matlab MEX files]] may be compiled from the command line as described in their documentation~~.
	# ~~When using BCB 2006, you may experience~~ "~~invalid property~~" ~~runtime errors when running BCI2000. This may be due~~ to ~~imperfect import of *.dfm files. Make sure to install all available updates, then import a clean version of~~ the ~~BCI2000 source tree. If this doesn't help, consider updating to BCB2009~~.

	===~~Building Contributions~~===
	~~====From the command line====~~
	~~After building BCI2000 from the command line, the <tt>makefiles<~~/~~tt>~~ file ~~in the <tt>src</tt> directory contains a full list of subprojects.~~
	~~Those from the contribution section are commented out with a # character in front. When you remove the # character in front of a project, and do a "make all" or "make build", the additional project~~ will be ~~included in~~ the build.
	~~Likewise, you may speed up builds by commenting out parts of~~ the ~~core distribution that you don't need~~.

	===~~=From the IDE=~~===
	~~Open~~ the ~~contrib project group in the <tt>src/contrib</tt> directory~~, and build the ~~contributions you want~~.

	[[Category:Howto]][[Category:Development]]		[[Category:Howto]][[Category:Development]]

Mellinger at 13:18, 9 February 2011

2011-02-09T13:18:24Z

← Older revision		Revision as of 13:18, 9 February 2011
Line 1:		Line 1:
			#REDIRECT [[Programming Reference:Build System]]

	This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.		This document describes how to build BCI2000, i.e. how to create the BCI2000 executables from their source code.

Mellinger: /* Why to build */

2010-03-05T14:35:25Z

Why to build

← Older revision		Revision as of 14:35, 5 March 2010
Line 4:		Line 4:
	Typically, you will install BCI2000 from its [[BCI2000 Binaries\|binary distribution]], and do not need to build BCI2000, unless		Typically, you will install BCI2000 from its [[BCI2000 Binaries\|binary distribution]], and do not need to build BCI2000, unless
	*you want to always use its most current SVN version,		*you want to always use its most current SVN version,
	*you want to use code from the [[Contributions:Contents\|Contributions]] section,		*you create your own module by modifying an existing one,
	*you create your own module by modifying an existing one, or create a new ~~one~~ from scratch.		*you create a new module from scratch.

	== Tools required ==		== Tools required ==