Rebuild BCI2000: Difference between revisions
Wengelhardt (talk | contribs) Created page with "This tutorial is for developers who have downloaded the prerequisites and have the source code. If the follow the previous steps, you will have the full, default version of BCI2000 on your local computer. This maximizes the ease-of-use and flexibility for any custom uses. However, if you want to include any changes in the BCI2000 infrastructure, '''you will need to rebuild the appropriate modules in BCI2000'''. This..." |
Wengelhardt (talk | contribs) No edit summary |
||
| Line 8: | Line 8: | ||
We will first go over the steps to completely rebuild BCI2000, then detail how this process can be streamlined for specific cases. | We will first go over the steps to completely rebuild BCI2000, then detail how this process can be streamlined for specific cases. | ||
=Full rebuild= | |||
#Run ''Configure.sh.cmd'' in the BCI2000 <code>build</code> directory [[File:Use cmake 1.PNG|thumb|Step 1 - Run ''Configure.sh.cmd'']] | |||
#Press <code>Generate</code> (this automatically runs <code>Configure</code> then <code>Generate</code>). This runs CMake to reconfigure the BCI2000 solution. Essentially, it draws all the paths between the files and makes everything ready to compile. [[File:Use cmake 9.PNG|thumb|Step 3 - CMake is reconfigured and generated]] | |||
#Press the <code>Open Project</code> button or open <code>BCI2000.sln</code> in the <code>build</code> folder to open it in Visual Studio. | |||
#In Visual Studio, go to <code>Build → Build Solution</code>, or right-click ''Solution 'BCI2000''' in the ''Solution Explorer''. [[File:Use vs2017 3.png|thumb|Step 4 - Build full solution]] | |||
''Final Result'': Every executable in the <code>prog</code> folder has been updated! | |||
Revision as of 18:59, 13 May 2025
This tutorial is for developers who have downloaded the prerequisites and have the source code. If the follow the previous steps, you will have the full, default version of BCI2000 on your local computer. This maximizes the ease-of-use and flexibility for any custom uses.
However, if you want to include any changes in the BCI2000 infrastructure, you will need to rebuild the appropriate modules in BCI2000. This page will first detail how to choose what needs to be rebuilt, and then what steps are needed to rebuild BCI2000 with your changes.
What needs to be rebuilt?

BCI2000 always runs 4 modules (executables, .exe), as shown here. To run BCI2000, all 4 executables are run. Therefore, to update BCI2000, these executables need to be updated. In fact, only the executable that includes custom changes need to be updated. Therefore, in most cases (e.g., adding a custom filter, module, or extension), only one executable needs to be updated.
We will first go over the steps to completely rebuild BCI2000, then detail how this process can be streamlined for specific cases.
Full rebuild
- Run Configure.sh.cmd in the BCI2000
builddirectoryStep 1 - Run Configure.sh.cmd - Press
Generate(this automatically runsConfigurethenGenerate). This runs CMake to reconfigure the BCI2000 solution. Essentially, it draws all the paths between the files and makes everything ready to compile.Step 3 - CMake is reconfigured and generated - Press the
Open Projectbutton or openBCI2000.slnin thebuildfolder to open it in Visual Studio. - In Visual Studio, go to
Build → Build Solution, or right-click Solution 'BCI2000' in the Solution Explorer.
Step 4 - Build full solution
Final Result: Every executable in the prog folder has been updated!