View source for Contributions:Patches

==Patches==
Patches are modifications to the BCI2000 source code that may affect a few files, or many.
Typically, such modifications are made in order to add some configuration option to a BCI2000 module, or you make a small modification to an analysis tool in order to make it easier to use.
Patches are shared in form of text files that contain the differences between the unchanged source code, and your modified source code.

==Creating a Patch==
===Windows (TortoiseSVN)===
*If you added new files to the BCI2000 source code, make sure to add them to SVN by right-clicking and choosing TortoiseSVN->Add... from the context menu.
*Right-click your BCI2000 folder and choose TortoiseSVN->Create Patch... from the context menu.
*In the list of modified files, deselect those that contain changes unrelated to your modification, and click OK.
*In the File Save dialog, save the patch to any location, and provide a name that gives some idea about the modification.
===Command-line SVN===
*Make sure to call <code>svn add</code> on all files that you added to the source code.
*CD to the BCI2000 directory, and execute <code>svn diff > MyModification.patch</code>.

==Uploading a Patch==
No special permission is required to upload a patch. Everyone with a BCI2000 user account may log into the wiki, edit the patches page, and upload a patch. In order to upload a patch, please follow these steps:
*Make sure you are logged into the wiki. Use the "log in" link at the top right of the wiki page in order to log in. When prompted for a user account and password, use your BCI2000 user account.
*Click the "Upload file" link from the wiki toolbox to the left. In the upload page, choose your patch file, and put a few lines of description into the "Summary" field. Then, click "upload".

==Contributed Patches==
===KeyToAdvance===
This patch adds a configuration option to the StimulusPresentation application. When a "KeyToAdvance" row is added to the "Stimuli" matrix, then the entries in this row represent keys that must be pressed in order for the presentation to advance from the stimulus associated with that key. Without the proper key press, presentation will wait indefinitely.
[{{{servername}}}/wiki/index.php Download]
[[Image:KeyToAdvance.patch|Description page]]