Golden Harvest Editing Guide
Manufacturer Quick User Guide - Download
In Depth Manual - Download
First Steps
After plugging your saber into your computer open the root directory and make a copy of the default files. Save this copy to your computer for future use if you make a mistake or want to rollback to the default files. This is a best practice when editing any file(s).
Formatting SD Card
If you want to update the firmware or edit the soundfonts or effects folders/files, you should reformat your SD card first. If you are only editing the general.txt this is not necessary. Formatting the SD card will prevent formatting errors that have appeared on some SD cards. To reformat your SD card use the links below to download the software required for correct formatting. When formatting make sure to use the "quick format" option.
Firmware update v3.33 (PDF with download links) - Available Here
General Settings
The general settings of your Golden Harvest v3 board can be found in the "general.txt" file on your microSD card. When the board boots, it loads all the parameters that are contained in this file. These parameters define the behavior of your board. You can customize the parameters in the "general.txt" using a text editor or using our online configurator (Coming Soon). The pictures below show the default folder structure and settings and values you will find in "general.txt" when you receive your saber.
Folder Structure
General.txt file structure
Regarding Thresholds
Each type of motion has a threshold parameter that belongs to it. This threshold parameter is a measure for the sensitivity as it specifies how strong a motion has to be in order to detect the respective motion type. The higher the threshold, the smaller the sensitivity. In addition to the threshold parameter, spins have a trigger duration parameter. It describes the duration that the motion has to cross the threshold parameter without any interruption. Essentially, this corresponds to how long you have to rotate your saber without any interruption in order to trigger a spin effect.
Parameter Descriptions
| Parameter | Definition |
|---|---|
| Volume | Defines the loudness of your saber. Ranges from 0 (mute) to 200 (maximum loudness). We set our default volume at 175. Increase further at your own risk. We cannot be held responsible. |
| button_off_time | Defines how long you have to press the power button to turn your saber off. Recommended value of 250. |
| button_on_time | Defines how long you have to press the power button to turn your. saber on. Recommended value of 10. |
| button_short_time | In the menu navigation, a short button press triggers certain features (see section "Menu navigation"). This parameter defines how long you have to press a button to be recognized as a short press. Recommended value of 5. |
| button_normal_time | In the menu navigation, a normal button press triggers certain features (see section "Menu navigation"). This parameter defines how long you have to press a button to be recognized as a normal |
| button_long_time | In the menu navigation, a long button press triggers certain features (see section "Menu navigation"). This parameter defines how long you have to press a button to be recognized as a long press. Recommended value of 200. |
| button_mode | Defines which switch configuration you’re using. |
| button_reverse | |
| blade_double_tap | There are background effects and on top effects that can be changed on the fly. Usually, different background effects correspond to different colors. This parameter is set to 1, a double tap changes the background effects and a single tap changes the on top effects. If it is set to 0, a single tap changes the background effects and a double tap changes the on top effect. Please keep in mind that for some button layouts described in the section "Menu navigation", a double tap is replaced by a twist motion of the saber. |
| stab_ignition | |
| swing_ignition |
swing_ignition=0: The swing ignition feature is disabled. swing_ignition=1: The swing ignition feature is enabled. |
| twist_retraction |
twist_retraction=0: The twist retraction feature is disabled. twist_retraction=1: The twist retraction feature is enabled |
| twist_protection | The twist retraction is blocked if the movement of the saber is stronger than this parameter. This avoids that the saber accidentally turns off during movement. |
| color_wheel |
Color_wheel=0: The color wheel feature is disabled. Color_wheel=1: When in color wheel mode, the color can be changed by tilting the saber. Color_wheel=2: When in color wheel mode, the color can be changed by twisting the saber. Color_wheel=3: When in color wheel mode, the color can be changed both by tilting the saber and by twisting it. |
| color_wheel_tilt_speed | Defines the sensitvity of tilting the saber. |
| color_wheel_twist_speed | Defines the sensitvity of twisting the saber. |
| volume_control |
volume_control=0: The volume control feature is disabled. volume_control=1: When in volume control mode, the volume can be changed by tilting the saber. volume_control=2: When in volume control mode, the volume can be changed by twisting the saber. volume_control=3: When in volume control mode, the volume can be changed both by tilting the saber and by twisting it. |
| volume_control_tilt_speed | Defines the sensitvity of tilting the saber. |
| volume_control_twist_speed | Defines the sensitvity of twisting the saber. |
| orientation | Defines the orientation of the board in your saber which is required for the orientation detection based features to work properly. |
| swing_threshold | Defines the minimum rotation speed of your saber required to trigger a swing when using the legacy motion detection. The lower this value, the more sensitive your swing detection is. Recommended values between 3000 and 7000. |
| clash_threshold | Defines the minimum strength with which you hit an obstacle required to trigger a clash. The lower this value, the more sensitive your clash detection is. Recommended values between 2000 and 4000. |
| stab_threshold | Defines the minimum strength with which you perform a stab required to trigger a stab. The lower this value, the more sensitive your stab detection is. Recommended values between 2500 and 6000. |
| spin_threshold | Defines the minimum rotation speed of your saber required to trigger a spin when using the legacy motion detection. The lower this value, the more sensitive your spin detection is. Recommended values between 12000 and 17000. |
| spin_trigger_duration | Defines how long you have to rotate your saber with the minimum rotation speed defined by "spin_threshold" without any interruption to trigger a spin. The lower this value, the more sensitive your spin detection is. Recommended values between 300 and 500. |
| accent_swing_threshold | Defines the minimum rotation speed of your saber required to trigger an accent swing when using smooth swing. The lower this value, the more sensitive your accent swing detection is. Recommended values between 12000 and 15000. |
| accent_spin_threshold | Defines the minimum rotation speed of your saber required to trigger an accent spin when using smooth swing. The lower this value, the more sensitive your accent spin detection is. Recommended values between 17000 and 20000. |
| twist_threshold | Defines the minimum twist speed around the pommel to tip axis of your saber required to recognize a twist motion. The twist motion is used by some button layouts described in the section "Menu navigation" instead of a double tap. The lower this value, the more sensitive your twist detection is. Recommended values between 20000 and 25000. |
| swing_cooldown | Defines how long no other swing can be triggered after a swing has been detected. Can protect swings from a too fast interruption by other swings. Recommended values between 200 and 300. |
| clash_cooldown | Defines how long no other clash can be triggered after a clash has been detected. Can protect clashes from a too fast interruption by other clashes. Recommended values between 0 and 200. |
| stab_cooldown | Defines how long no other stab can be triggered after a stab has been detected. Can protect stabs from a too fast interruption by other stabs. Recommended values between 100 and 300. |
| spin_cooldown | Defines how long no other spin can be triggered after a spin has been detected. Can protect spins from a too fast interruption by other spins. Recommended values between 100 and 300. |
| blasterblock_protection | Defines how long no motion can be triggered after a blaster block has been triggered. This holds only for legacy motion detection. If you want to protect the blaster block completely, set this parameter to a high value. Recommended values between 0 and 10000. |
| forcepush_protection | Defines how long no motion can be triggered after a force push has been triggered. This holds only for legacy motion detection. If you want to protect the force push completely, set this parameter to a high value. Recommended values between 0 and 10000. |
| effect_font_slot | |
| effect_fading | Defines the transition time between two different effects when you change the background effect or the on top effect. Recommended value between 0 and 750. |
| neopixel | Defines whether or not you are using Pixel strips to illuminate your blade. Set this parameter to 0 if you are not using Pixel strips and set it to 1 if you are. |
| number_of_leds | If you are using Pixel strips (Neopixel), set this parameter to the number of Pixel LEDs in your blade. Please count only the number of LEDs of one of the Pixel strips. Usually, the number is between 110 and 135. The number of LEDs is internally clamped to 140. |
| number_of_neopixel_accents | Defines whether or not you are using the USB file transfer feature of the Seedling. Set this parameter to 0 if you are not using the USB feature and set it to 1 if you are using the USB feature. |
| usb | Defines whether or not you are using the USB file transfer feature of the Seedling. Set this parameter to 0 if you are not using the USB feature and set it to 1 if you are using the USB feature. |
| poweron | Defines the ignition duration if you are using Pixel strips. If you set this parameter to 0, the ignition duration will be coupled to the duration of the poweron sound. If you set this parameter to a value different from 0, this value will give the ignition duration in units of 5 milliseconds. A value of 100 corresponds to an ignition duration of 500 milliseconds for example. Please do not use a longer ignition duration than the duration of the power on sound. |
| poweroff | Defines the retraction duration if you are using Pixel strips. If you set this parameter to 0, the retraction duration will be coupled to the duration of the poweron sound. If you set this parameter to a value different from 0, this value will give the retraction duration in units of 5 milliseconds. A value of 100 corresponds to a retraction duration of 500 milliseconds for example. Please do not use a longer retraction duration than the duration of the power off sound. |
| battery_low | The Golden Harvest v3 measures the battery voltage and has a low battery warning feature. If the battery voltage falls below a customizable threshold, the low battery sound is played. This parameter defines the threshold that triggers the low battery sound as soon as the battery voltage falls below it. |
| deep_sleep | Defines the time after which the board enters the Hibernation Mode if it’s not used used while it’s powered. Values are given in seconds. |