How to use the board creation Excel tool
Learn how to use the Board Creation Excel Tool.
Get the Board Creation Excel Tool
Download the file from the link below and extract the files from the ZIP file.
Create Board Layout Parameters
To define the layout and parameters of the board, you need to edit it in Excel and save it as a .xlsx file. You can create it from scratch or edit it based on the file you're distributing as a sample.
It can also be any file name, but it can also be the file name of the final output board container definition file.
Board Container Parameters
To create parameters for a board container, create a Container sheet. This sheet must be made.
Create headers for the first column "Key" and the second column "Value" in the first row.
In the Key column, enter a distinguished name that identifies the value, and then enter each value in the Value column. The parameters that can be specified are:
- IdentityName
- Author
- Version
- IsExcludeNextBoard
- Order
- KeyReleaseTimingWhenActiveWindowChange
- Remarks
For more information about each parameter, please refer to the file definition link below.
See below for information on the Excel tool creation and its own settings.
| Key | Remarks |
|---|---|
| IdentityName | This parameter is mandatory. |
| GeneratorIdentityName | It is set automatically. |
| GeneratorVersion | It is set automatically. |
Board Parameters
To create parameters for a board, create a Boards sheet. This sheet must be made.
In the first line, enter the distinguished name of the board's parameters.
From the second line onwards, enter the board for a few minutes at a time to match the parameters in the header.
The parameters that can be specified for a column are:
- IdentityName
- Position
- StartPositionType
- PositionOffset
- NextBoardPositionType
- CenterPosition
- FontSizeScale
- BoardScale
- ImageName
- ImageStretchMode
For more information about each parameter, please refer to the file definition link below.
See below for information on the Excel tool creation and its own settings.
| Key | Remarks |
|---|---|
| Position | You usually enter the size of the board here, but if you don't, it will automatically determine it to fit the key layout. However, since the display position will be (0, 0), the display position must be specified with the StartPositionType and PositionOffset parameters. For each parameter, enter "X, Y, Width, Height" separated by commas. |
| PositionOffset | For each parameter, enter "X, Y" separated by commas. |
| CenterPosition | For each parameter, enter "X, Y" separated by commas. |
Key layout
To create a key layout, create a {X}_Layout sheet. For the "{X}" part, specify the index of the board starting with 1. If you need to display more than one board, you will need this sheet as many boards as you want.
In this sheet, you will insert shapes to create a layout for the keys. You can place any shape, but at the moment you can only create a rectangular key, so we recommend using a rectangular shape.
Once the shape is placed, enter the key distinguished name inside the shape. This distinguishing name is associated with the key parameter. Note that it is not the text that appears on the key.
If you enter an identification name that does not exist in the key parameter, the text you enter will be set to "KeyType" or "DisplayText" of the key parameter. Please note that if a non-existent "KeyType" is specified, the application will not be able to load it.
When placing shapes, the size of the cells behind them does not affect the output.
Key Parameters
To create key parameters, create a {X}_KeyDefine sheet. For the "{X}" part, specify the index of the board starting with 1. This sheet is paired with {X}_Layout. If you need to display more than one board, you will need this sheet as many boards as you want.
In the first line, enter the distinguished name of the key's parameter.
From the second line onwards, enter the number of keys to be displayed on the target board according to the parameters in the header for each line.
The parameters that can be specified for a column are:
- Name
- KeyType
- Position
- DisplayText
- FontSize
- ImageName
- ImageStretchMode
- IsToggle
- IsOneClickToggleRelease
- Options
- Processes
For more information about each parameter, please refer to the file definition link below.
See below for information on the Excel tool creation and its own settings.
| Key | Remarks |
|---|---|
| Name | The name entered here is linked to the name entered in the shape in the layout sheet, and the key parameter entered is applied to the key at the target position. The output to the board container definition file is based on the layout sheet, so it doesn't matter if the name entered here is not in the layout sheet. |
| KeyType | If not, the value entered in the Name column is used. |
| Position | If you enter the position and size here, it will be used first, but you will usually use the position and size set in the key layout sheet, so basically you can leave it unentered. If you want to enter, enter "X, Y, Width, Height" separated by commas. The unit is a logical pixel. |
| DisplayText | By breaking the text in a cell, the actual display text is also broken. |
| Options | If you want to use it, please enter it according to the format. |
| Processes | If you want to use it, please enter it according to the format. |
Board decoration
You can set detailed decorations for the appearance of the board.
On the first line, enter the distinguished name of the parameters of the board decoration. From the second line onwards, we will set the decoration of the board for each target board and condition.
You can specify which boards to apply to by entering the IdentityName specified in the Boards sheet for TargetBoardName.
You can also specify when the IME should be applied for "ImeStatuses" and which key to apply while pressing for "PressKeys".
The parameters that can be specified for a column are:
- IdentityName
- TargetBoardName
- ImeStatuses
- PressKeys
- BackgroundColor
- ImageName
- ImageStretchMode
- BorderColor
- BorderThickness
For more information about each parameter, please refer to the file definition link below.
See below for information on the Excel tool creation and its own settings.
| Key | Remarks |
|---|---|
| TargetBoardName | Specify which boards you want it to apply to. The name you specify is the IdentityName specified in the Boards sheet. |
| ImeStatuses | Specifies when the IME is currently in which the decoration is applied. For information on which values can be specified, see Defining BoardDecorateInfo. If you want to enter more than one, enter it separated by commas. (e.g., KanaInputAlphaHalf, KanaInputKatakanaHalf) |
| PressKeys | Specify which keys apply decorations while pressing. For example, if you specify LeftShift, the decoration will be applied when the Shift key is pressed. If you want to apply multiple keys at the same time, specify multiple with a comma separation. |
| BackgroundColor | Specify the color from 0~255. Enter the values as "A,R,G,B" separated by commas. |
| BorderColor | Specify the color from 0~255. Enter the values as "A,R,G,B" separated by commas. |
Key decoration
You can set detailed decorations regarding the appearance of the keys.
In the first line, enter the distinguished name of the key decoration parameter. From the second line onwards, we will set the key decoration for each target key and condition.
You can specify which key to apply to by entering the "Name" specified in the "{X}_KeyDefine" sheet in the "TargetBoardName".
You can also specify when the IME is applied to "ImeStatuses", which key is applied while pressing, and "IsPressed" which key is pressed.
The parameters that can be specified for a column are:
- IdentityName
- TargetKeyName
- ImeStatuses
- PressKeys
- IsPressed
- DisplayText
- FontName
- FontSize
- TextBold
- TextColor
- BackgroundColor
- ImageName
- ImageStretchMode
- BorderColor
- BorderThickness
For more information about each parameter, please refer to the file definition link below.
See below for information on the Excel tool creation and its own settings.
| Key | Remarks |
|---|---|
| TargetKeyName | Specify which key you want it to apply to. The name to be specified is the "Name" specified in the "{X}_KeyDefine" sheet. |
| ImeStatuses | Specifies when the IME is currently in which the decoration is applied. See Defining KeyDecorateInfo for which values can be specified. If you want to enter more than one, enter it separated by commas. (e.g., KanaInputAlphaHalf, KanaInputKatakanaHalf) |
| PressKeys | Specifies which of the other keys will apply the decoration while pressed. For example, if you specify LeftShift, the decoration will be applied when the Shift key is pressed. If you want to apply multiple keys at the same time, specify multiple with a comma separation. You can also include your own key in the condition. |
| IsPressed | TRUE. Apply decorations when your key is being pressed. FALSE or unspecified, the normal key decoration. |
| TextColor | Specify the color from 0~255. Enter the values as "A,R,G,B" separated by commas. |
| BackgroundColor | Specify the color from 0~255. Enter the values as "A,R,G,B" separated by commas. |
| BorderColor | Specify the color from 0~255. Enter the values as "A,R,G,B" separated by commas. |
Creating a Board Container Definition File
Creation
Move the created board definition file (.xlsx) to the folder with the "BoardCreator_x_xx.xlsm" file. (x_xx is the version)
Once you've moved the file, open BoardCreator.xlsm. By clicking the "Generate Board Container Definition File" button displayed on the sheet, a board container definition file is generated based on the .xlsx file placed in the folder.
When the process is successfully completed, you will see the ". A "board container definition file" with the extension "setting" is created.
Security
Since "BoardCreator.xlsm" is an Excel file that contains macros, you may receive a warning when you open it, as shown in the image. (The message may be different from the figure)
If you see a warning, allow the macro to run. If you do not allow it, you will not be able to create a "board container definition file".
Placing the board container definition file
Place the created board container definition file (.setting) in the "Boards\Default\" folder of the folder with "TiitanTouchBoard.exe". After placement, the touchboard will be loaded when you start it.
If you specify the wrong parameters, you may get an error during execution, so please review the settings of the target board and recreate it.
About the sample boards included
To make it easier for first-timers to create boards, the Board Creation Excel tool includes a sample board that is small for each feature of the original board package that is distributed. The included samples are:
| File name | summary | image |
|---|---|---|
| 010_Normal_1_03_Ja | This is the keyboard with the normal layout included by default. | |
| 020_Thumb_1_03_Ja | This is a keyboard with a thumb layout that is included in the default state. | |
| 030_MousePad_1_03_Ja | This is a mouse pad that is included in the initial state. | |
| 031_MousePadOneHandLeft_1_03_Ja | This is a left-hand mouse pad included in the board package. | |
| 032_MousePadOneHandRight_1_03_Ja | This is a right-hand mouse pad included in the board package. | |
| 033_MousePadExtensionKey_1_03_Ja | This is an extended mouse pad included in the board package. | |
| 040_TenKeyLeft_1_03_Ja | This is a left-hand numeric keypad included in the board package. | |
| 041_TenKeyRight_1_03_Ja | This is a right-hand numeric keypad included in the board package. | |
| 042_TenKeyLeftNumLock_1_03_Ja | This is a left-hand NumLock numeric keypad included in the board package. | |
| 043_TenKeyRightNumLock_1_03_Ja | This is the numeric keypad for the right hand NumLock included in the board package. | |
| 050_GameController_1_03_Ja | This is the game controller included in the board package. | |
| 060_IllustCspLeft_1_03_Ja | This is a Clip Studio Paint left-hand shortcut board included in the board package. | |
| 061_IllustCspRight_1_03_Ja | This is a shortcut board for the Clip Studio Paint right-hand that is included in the board package. | |
| 062_IllustPsLeft_1_03_Ja | This is the Photshop left-hand shortcut board included in the board package. | |
| 063_IllustPsRight_1_03_Ja | This is a Photshop right-hand shortcut board included in the board package. | |
| 501_MinimumBoardSample_1_03_Ja | This is a sample board created in the smallest possible configuration. | |
| 502_FourBoardsSample_1_03_Ja | This is a sample board with four boards placed in the four corners. | |
| 503_BoardPositionSample_1_03_Ja | A sample board with a board in any position and size. | |
| 504_BoardPositionOffsetSample_1_03_Ja | This is a sample board with the board shifted from its initial position. | |
| 505_BoardScaleSample_1_03_Ja | This is a board sample with an enlarged version of the entire board and key text. | |
| 506_BoardImageSample_1_03_Ja | This is a sample board with an image on the background of the board. | |
| 511_ImeOnOffDecorateSample_1_03_Ja | This is a sample of switching board decorations according to the IME on and off. | |
| 512_ImeDetailDecorateSample_1_03_Ja | This is a sample of switching board decorations according to detailed specifications such as IME kana input and Roman character input. Switching colors for each IME will help you understand the current IME status. | |
| 513_PressKeyBoardDecorateSample_1_03_Ja | This is an example of switching the decoration of the board depending on the state of the key pressed. Press the Shift or Ctrl key to switch the background of the board. | |
| 514_TransparentColorBoardSample_1_03_Ja | This is a sample that transmits the background of the board. This also allows you to create a board with only the keys floating. | |
| 515_TransparentImageBoardSample_1_03_Ja | A sample of a board made into any shape using a transparent image on the background of the board. You can also create a free-form board by using a cropped image of the key background. | |
| 521_KeySimpleDecorateSample_1_03_Ja | This is a sample with standard decorations applied to the keys. You can specify "key text", "font size", "background color", etc. | |
| 522_KeyToggleSample_1_03_Ja | This is an example to check the toggle behavior of various keys. | |
| 523_CustomProcessKeySample_1_03_Ja | This is an example of customizing the key press process to perform various keystrokes. You can perform shortcut actions such as "Undo", "Redo", "Select All", and "Open Explorer", and you can enter multiple characters such as emoticons at once. | |
| 524_SpecialKeySample_1_03_Ja | An example with a minor key that is defined as a key but is rarely used. It's just a collection of defined things, so there may be some things that don't happen when you press a key. Some may behave differently depending on the OS and preferences. | |
| 531_KeyExtendDecorateSample_1_03_Ja | This is a sample with detailed decorations applied to the keys. You can specify various settings such as "display text", "font", "text color", "background color", "background image", and "border". | |
| 532_KeyImeDecorateSample_1_03_Ja | This is a sample where the decoration of the key changes depending on the state of the IME. The letters entered when the keys are pressed can be recognized by the state of the IME. | |
| 533_KeyPressDecorateSample_1_03_Ja | This is a sample in which the decoration of the key changes depending on the pressing state of the specified key. Press the Shift or Ctrl keys to change the text above, for example. | |
| 534_KeyLockDecorateSample_1_03_Ja | This is an example of getting the state of a key toggle state that is managed by Windows, such as CapsLock and Insert, and changing the design of the key. |