saber_BC_buttons.h

Features:

- Live preset changing while blade is running (skips font.wav and preon).

- Battle Mode, gesture ignitions, and multi-blast based on fett263's work.

- Auto enter/exit multi-blaster block mode.

- Spoken Battery level in volts OR percentage. Both always available.

- Dedicated Quote sounds - Always available. force.wavs can remain as force.

Add quote.wav files to font to use.

Live toggle between sequential or random quote play.

- Play / Stop track control while blade is on.

- Force Push is always available, not just in Battle Mode.

- Melt is always available as no button, with pull-away or button to end.

- Drag is always clash with button pressed while pointing down.

- No blade inserted = no gestures option if Blade Detect is used.

- Optional On-the-fly volume controls with Quick MIN and MAX levels.

- Bypass preon and/or postoff based on blade angle.

- Spam Blast - Enter this mode to make the button super sensitive for

multiple blaster blocks. Presses are prioritized over

other features. No limits, no lag when "rapid firing".

- Swap feature with sound - Just an additional EFFECT that can be used to trigger

blade animations. See below.

---------------------------------------------------------------------------

Optional Blade style elements:

On-Demand battery level - A layer built into the blade styles that reacts

as the battery gets weaker, changing blade color

from Green to Red, and the blade length shortens.

EFFECT_USER1 - Swap feature: Use as a standalone trigger for EffectSequence<>,

for example as a way to have multiple blade styles in one preset.

Usage:EffectSequence<EFFECT_USER1, item1, item2...>

Custom swap.wav files can be used as the sound effect,

otherwise ccchange.wav is used.

EFFECT_USER2 - For blade effects with sounds that might work better without hum,

this plays sounds monophonically.

(think seismic charge silence, iceblade etc...)

monosfx.wav files are used. It can be just the sound, or a

blade effect too by using EFFECT_USER2 in a TransitionEffectL.

---------------------------------------------------------------------------

Optional #defines:

#define ENABLE_AUTO_SWING_BLAST - Multi-blast initiated by simply swinging

within 1 second of last blast.

Exit by not swinging for 1 second.

#define FEMALE_TALKIE_VOICE - To use a female voice version of onboard Talkie.

#define NO_VOLUME_MENU - Option to omit On-the-fly Volume menu control with buttons.

---------------------------------------------------------------------------

Gesture Controls:

- There are four gesture types: swing, stab, thrust and twist.

For simplicity, using gesture ignition will automatically skip the preon effect.

Below are the options to add to the config to enable the various gestures.

#define BC_SWING_ON

#define BC_STAB_ON

#define BC_THRUST_ON

#define BC_TWIST_ON

#define BC_TWIST_OFF

#define NO_BLADE_NO_GEST_ONOFF

- If using blade detect, Gesture ignitions or retractions are disabled.

**NOTE** Only works when a BLADE_DETECT_PIN is defined.

#define BC_FORCE_PUSH

- This mode plays a force sound (or force push sound if the font contains it) with

a controlled pushing gesture, and is always available, not just in Battle Mode.

#define BC_FORCE_PUSH_LENGTH

- Used for adjustment to the Push gesture length in millis needed to trigger

Force Push. Recommended range 1 ~ 10,

1 = shortest, easiest to trigger, 10 = longest. Default value is 5.

#define BC_NO_BM

- Disable battle mode features.

#define BC_GESTURE_AUTO_BATTLE_MODE

- Makes gesture ignition ALSO enter battle mode automatically on ignition.

- *Note* - Cannot be used if #define BC_NO_BM is active.

"Battle Mode 1.0" by fett263, BC modified version:

- Once you enter battle mode, buttons are not used for lockup.

Clashing the blade against something will automatically do lockup and then end

when you pull away.

- Automatic lockup and grazing clash (swinging through) detection works

by measuring delay of the saber blade pulling back from the clash.

If you clash the blade and it does not pull back during the delay period,

it is assumed to be a lockup and the lockup effect will show on the blade.

If you clash the blade and pull away, only the bgn/end lockup effects will show.

You can adjust the threshold of this detection by using:

#define BC_LOCKUP_DELAY (insert number here)

Default value is 200.

If you don't rebound off the object (opponent's blade) but instead clash while

swinging through, clash will automatically trigger.

- To manually override the auto-lockup temporarily and get a regular clash,

hold any button while clashing.

- Automatic clash/lockup uses the pre and post lockup effects

so your blade style and font MUST have those capabilities to support

battle mode.

- Melt will automatically trigger with no buttons when you physically

stab something, and end when you pull away or push any button.

- Stab will trigger with no buttons and thrusting forward.

====================== 1 BUTTON CONTROLS ========================

| Sorted by ON or OFF state: (what it's like while using saber) |

=================================================================

************* WHILE SABER BLADE IS OFF ***************

Turn blade ON - Short click POW. (or gestures if defined, uses FastOn)

* NOTE * Gesture ignitions using FastOn bypass preon.

Turn ON without preon - Short click POW while pointing up.

Turn blade ON Muted - 4x click and hold POW.

Next Preset - Long click and release POW.

Prev Preset - Double click and hold POW, release after a second (click then long click).

Play/Stop Track - 4x click POW.

Volume Menu:

* NOTE * Tilting blade too high or low in Volume Menu will give a warning tone to

tilt up or down to avoid erratic rotational volume changes at extreme blade angles.

Enter/Exit - Hold POW + Clash.

Volume UP - Rotate Right

- or -

- Long click and release POW while in Volume Menu. (just like next preset)

Volume DOWN - Rotate Left

- or -

- Double click and hold POW, release after a second while in Volume Menu.

 (click then long click, just like next preset)

Quick MAX Vol - Short click POW while in Volume Menu.

Quick MIN Vol - Double click POW while in Volume Menu.

Spoken Battery Level

in volts - Triple click POW.

in percentage - Triple click and hold POW.

On-Demand Batt Level - Double click POW.

(requires EFFECT_BATTERY_LEVEL to be in blade style,

and uses battery.wav sound effect.)

************* WHILE SABER BLADE IS ON ****************

Play/Stop Track - 4x click POW.

Next Preset Fast - Long click and release POW while pointing up.

Prev Preset Fast - Double click and hold POW, release after a second while pointing up. (click then long click)

 * NOTE * Fast switching bypasses preon and font.wav.

Clash - No buttons, just hit the blade against something.

In Battle Mode, Hold POW and Clash to temporarily

override the auto-lockup and do regular Clash.

Stab - Just Thrust forward with a stabbing motion.

Works in Battle Mode.

Blaster Blocks - Click or Double click POW.

Spam Blaster Blocks - 3x click and hold while pointing up. This toggles SPAM BLAST mode ON/OFF,

and makes the button super sensitive for multiple blaster blocks.

* Note * This gets in the way of normal features,

so turn off when you're done spamming. Plays mzoom.wav.

Auto Swing Blast - if #define ENABLE_AUTO_SWING_BLAST is active,

swinging within 1 second of doing button activated

Blaster Block will start this timed mode.

To trigger auto blaster blocks, swing saber

within 1 second of last Swing Blast block.

To exit, stop swinging for 1 second.

Lockup  - Hold POW + Clash.

In Battle Mode, just Clash and stay there,

pull away or press POW to end lockup.

Drag - Hold POW + Clash while pointing down.

Melt - No button, just stab something. pull away or

press POW to end.

Lightning Block - Double click and hold POW.

Battle Mode - Triple click and hold POW to enter and exit.

Power OFF is disabled while in Battle Mode,

YOU MUST EXIT THE MODE WITH THIS COMBO FIRST.

Force Effect - Hold POW + Twist. (while NOT pointing up or down)

Monophonic Force - Hold POW + Twist. (while pointing up)

Color Change Mode - Hold POW + Twist. (while pointing down)

Rotate hilt to cycle through all available colors, or

Click POW to change if ColorChange<> used in blade style,

Click + hold POW to save color selection and exit.

 Triple click POW to cancel and restore original color.

ColorChange explained:

If the style uses ColorChange<>, when you activate color change mode,

there will be up to 12 steps per rotation with a little sound at each step.

If it does not use ColorChange<>, the color wheel will be activated,

which has 32768 steps per rotation.

COLOR_CHANGE_DIRECT makes it so that IF the style uses ColorChange<>,

when you activate color change mode, it will immediately go to the

next color and exit color change mode. If the style does not use

ColorChange<>, it has no effect.

Quote Player - Triple click POW.

Toggle sequential or

random quote play - 4x click and hold POW. (while pointing down)

Force Push - Push hilt perpendicularly from a stop.

Swap (EffectSequence) - 4x click and hold POW. (while NOT pointing up)

* Requires EFFECT_USER1 in blade style.

PowerSave Dim Blade - 4x click and hold POW. (while pointing up)

To use Power Save requires AlphaL based EffectSequence in style.

Turn off blade - Hold POW and wait until blade is off,

or Twist if using #define BC_TWIST_OFF.

Turn OFF without postoff - Turn OFF while pointing up.

====================== 2 BUTTON CONTROLS ========================

| Sorted by ON or OFF state: (what it's like while using saber) |

=================================================================

************* WHILE SABER BLADE IS OFF ***************

Turn blade ON - Short click POW. (or gestures if defined, uses FastOn)

* NOTE * Gesture ignitions using FastOn bypass preon.

Turn ON without preon - Short click POW while pointing up.

Turn blade ON Muted - 4x click and hold POW.

Next Preset - Long click and release POW.

Prev Preset - Double click and hold POW, release after a second (click then long click).

Play/Stop Track - Hold AUX + Double click POW.

Volume Menu:

* NOTE * Tilting blade too high or low in Volume Menu will give a warning tone to

tilt up or down to avoid erratic rotational volume changes at extreme blade angles.

Enter/Exit - Long click AUX.

Volume UP - Rotate Right

- or -

- Long click and release POW while in Volume Menu. (just like next preset)

Volume DOWN - Rotate Left

- or -

- Double click and hold POW, release after a second while in Volume Menu.

(click then long click, just like next preset)

Quick MAX Vol - Short click POW while in Volume Menu.

Quick MIN Vol - Double click POW while in Volume Menu.

Spoken Battery Level

in volts - Triple click POW.

in percentage - Triple click and hold POW.

On-Demand Batt Level - Double click POW.

(requires EFFECT_BATTERY_LEVEL to be in blade style,

and uses battery.wav sound effect.)

************* WHILE SABER BLADE IS ON ****************

Play/Stop Track - Hold AUX + Double click POW.

Next Preset Fast - Hold AUX + Long click and release POW while pointing up.

Prev Preset Fast - Hold AUX + Double click and hold POW for a second

while pointing up. (click then long click)

 * NOTE * Fast switching bypasses preon and font.wav.

Clash - No buttons, just hit the blade against something.

In Battle Mode, Hold any button and Clash to

temporarily override the auto-lockup and do regular Clash.

Stab - Just Thrust forward with a stabbing motion.

Works in Battle Mode.

Blaster Blocks - Click or Double click POW.

Spam Blaster Blocks - 3x click and hold while pointing up. This toggles SPAM BLAST mode ON/OFF,

and makes the button super sensitive for multiple blaster blocks.

* Note * This gets in the way of normal features,

 so turn off when you're done spamming. Plays mzoom.wav.

Auto Swing Blast - if #define ENABLE_AUTO_SWING_BLAST is active,

swinging within 1 second of doing button activated

Blaster Block will start this timed mode.

To trigger auto blaster blocks, swing saber

within 1 second of last Swing Blast block.

To exit, stop swinging for 1 second.

Lockup - Hold AUX + Clash.

In Battle Mode, just Clash and stay there,

pull away or press any button to end lockup.

Drag - Hold AUX + Clash while pointing down.

Melt - No button, just stab something,

pull away or press any button to end.

Lightning Block - Double click and hold POW.

Battle Mode - Hold POW + Click AUX to enter and exit.

Power OFF is disabled while in Battle Mode,

 YOU MUST EXIT THE MODE WITH THIS COMBO FIRST.

Force Effect - Hold POW + Twist. (while NOT pointing up or down)

Monophonic Force - Hold POW + Twist. (while pointing up)

Color Change Mode - Hold POW + Twist. (while pointing down)

Rotate hilt to cycle through all available colors, or

Click AUX to change if ColorChange<> used in blade style,

Click + hold POW to save color selection and exit.

 Triple click POW to cancel and restore original color.

ColorChange explained:

If the style uses ColorChange<>, when you activate color change mode,

there will be up to 12 steps per rotation with a little sound at each step.

If it does not use ColorChange<>, the color wheel will be activated,

which has 32768 steps per rotation.

COLOR_CHANGE_DIRECT makes it so that IF the style uses ColorChange<>,

when you activate color change mode, it will immediately go to the

next color and exit color change mode. If the style does not use

ColorChange<>, it has no effect.

Quote Player - Triple click POW.

Toggle sequential or

random quote play - Hold AUX + Twist. (while pointing down)

Force Push - Push hilt perpendicularly from a stop.

Swap (EffectSequence) - Hold AUX + Twist. (while NOT pointing up)

* Requires EFFECT_USER1 in blade style.

PowerSave Dim Blade - Hold AUX + Twist. (while pointing up)

(To use Power Save requires AlphaL based EffectSequence in style)

Turn off blade - Hold POW and wait until blade is off,

or Twist if using #define BC_TWIST_OFF.

Turn OFF without postoff - Turn OFF while pointing up.

====================== 1 BUTTON CONTROLS ========================
| Sorted by ON or OFF state: (what it's like while using saber) |
=================================================================

*************   WHILE SABER BLADE IS OFF   ***************
Turn blade ON         - Short click POW. (or gestures if defined, uses FastOn)
                       * NOTE * Gesture ignitions using FastOn bypass preon.
Turn ON without preon - Short click POW while pointing up.
Turn blade ON Muted   - 4x click and hold POW.
Next Preset           - Long click and release POW.
Prev Preset           - Double click and hold POW, release after a second (click then long click).
Play/Stop Track       - 4x click POW.
Volume Menu:
                     * NOTE * Tilting blade too high or low in Volume Menu will give a warning tone to
                       tilt up or down to avoid erratic rotational volume changes at extreme blade angles.
       Enter/Exit    - Hold POW + Clash.
       Volume UP     - Rotate Right
                     - or -
                     - Long click and release POW while in Volume Menu. (just like next preset)
       Volume DOWN   - Rotate Left
                     - or -
                     - Double click and hold POW, release after a second while in Volume Menu.
                       (click then long click, just like next preset)
       Quick MAX Vol - Short click POW while in Volume Menu.
       Quick MIN Vol - Double click POW while in Volume Menu.
Spoken Battery Level
       in volts      - Triple click POW.
       in percentage - Triple click and hold POW.
On-Demand Batt Level  - Double click POW.
                       (requires EFFECT_BATTERY_LEVEL to be in blade style,
                       and uses battery.wav sound effect.)

*************   WHILE SABER BLADE IS ON   ****************
Play/Stop Track       - 4x click POW.
Next Preset Fast      - Long click and release POW while pointing up.
Prev Preset Fast      - Double click and hold POW, release after a second while pointing up. (click then long click)
                       * NOTE * Fast switching bypasses preon and font.wav.
Clash                 - No buttons, just hit the blade against something.
                       In Battle Mode, Hold POW and Clash to temporarily
                       override the auto-lockup and do regular Clash.
Stab                  - Just Thrust forward with a stabbing motion.
                       Works in Battle Mode.
Blaster Blocks        - Click or Double click POW.
Spam Blaster Blocks   - 3x click and hold while pointing up. This toggles SPAM BLAST mode ON/OFF,
                       and makes the button super sensitive for multiple blaster blocks.
                       * Note * This gets in the way of normal features,
                       so turn off when you're done spamming.  Plays mzoom.wav.
Auto Swing Blast      - if #define ENABLE_AUTO_SWING_BLAST is active,
                       swinging within 1 second of doing button activated
                       Blaster Block will start this timed mode.
                       To trigger auto blaster blocks, swing saber
                       within 1 second of last Swing Blast block.
                       To exit, stop swinging for 1 second.
Lockup                - Hold POW + Clash.
                       In Battle Mode, just Clash and stay there,
                       pull away or press POW to end lockup.
Drag                  - Hold POW + Clash while pointing down.
Melt                  - No button, just stab something. pull away or
                       press POW to end.
Lightning Block       - Double click and hold POW.
Battle Mode           - Triple click and hold POW to enter and exit.
                       Power OFF is disabled while in Battle Mode,
                       YOU MUST EXIT THE MODE WITH THIS COMBO FIRST.
Force Effect          - Hold POW + Twist. (while NOT pointing up or down)
Monophonic Force      - Hold POW + Twist. (while pointing up)
Color Change Mode     - Hold POW + Twist. (while pointing down)
                       Rotate hilt to cycle through all available colors, or
                       Click POW to change if ColorChange<> used in blade style,
                       Click + hold POW to save color selection and exit.
                       Triple click POW to cancel and restore original color.
   ColorChange explained:
         If the style uses ColorChange<>, when you activate color change mode,
         there will be up to 12 steps per rotation with a little sound at each step.
         If it does not use ColorChange<>, the color wheel will be activated,
         which has 32768 steps per rotation.
         COLOR_CHANGE_DIRECT makes it so that IF the style uses ColorChange<>,
         when you activate color change mode, it will immediately go to the
         next color and exit color change mode. If the style does not use
         ColorChange<>, it has no effect.
Quote Player          - Triple click POW.
Toggle sequential or
 random quote play   - 4x click and hold POW. (while pointing down)
Force Push            - Push hilt perpendicularly from a stop.
Swap (EffectSequence) - 4x click and hold POW. (while NOT pointing up)
                       * Requires EFFECT_USER1 in blade style.
PowerSave Dim Blade   - 4x click and hold POW. (while pointing up)
                       To use Power Save requires AlphaL based EffectSequence in style.
Turn off blade        - Hold POW and wait until blade is off,
                       or Twist if using #define BC_TWIST_OFF.
Turn OFF without postoff - Turn OFF while pointing up.

Download Software 

ProffieOS7.8 Open-source lightsaber software

What you will need:

• Electronics: A Proffieboard or a TeensySaber V1, V2 or V3.
• Arduino IDE - I've been using 1.8.3, if you have problems with later versions, try 1.8.3.
• Proffieboard Arduino Plugin - If you have a proffieboard.
• Teensyduino - Teensy support for the Arduino IDE if you have a TeensySaber
• a micro-usb cable
• An SD card.
• Some sound fonts, tracks and/or voice packs.

ChangeLog (since 5.9)

• Proffieboard V3 support
• Audio high-pass filtering
• interrupt driven i2c
• 1600Hz motion sensing
• better WS2811 data buffering
• better filtering of high-frequency motion and gyro data
• much better display frame rates
• AudioLibrary
• Per-effect volume
• Per-effect "paired" setting.
• EFFECT_POSTOFF
• preon->ignition transition is now gapless
• Support for rotary inputs
• Support for potentiometer inputs
• Support for Savi's workshop blades
• pow/aux commands now allows for generating chords and different types of clicks
• blade styles used in your config file can now have arguments
• Maximum NUM_BLADES increased to 20
• Clash strength calculations (note that the clash strength can increas after the clash occurs.)
• Aurebesh font
• SaberBlasterProp
• Accent Swing file selection (replaces accent slashes)
• idle.bmp / idle.pbm support for OLED displays
• Many many bugfixes and optimizations.
• OLED bullet counts
• New Defines: DYNAMIC_BLADE_DIMMING, DYNAMIC_BLADE_LENGTH, DYNAMIC_CLASH_THRESHOLD, SAVE_BLADE_DIMMING, SAVE_CLASH_THRESHOLD, INCLUDE_SSD1306, FILTER_CUTOFF_FREQUENCY, FILTER_ORDER, NO_REPEAT_RANDOM, FEMALE_TALKIE_VOICE, DISABLE_BASIC_PARSER_STYLES and ENABLE_ALL_EDIT_OPTIONS
• New Styles: ColorSelect, StaticFire and Remap
• New Transitions: TrCenterWipe, TrCenterWipeIn, TrCenterWipeInSpark, TrColorCycleX, TrExtend, TrSelect, TrSpark,
• New Functions CenterDistF, ClashImpactF, EffectPosition, HoldPeakF, IntSelect, LinearSectionF, RampF, Sum, TimeSinceEffect, WavLen, Wavnum, SwingAcceleration,
• FETT263 PROP FEATURES: Edit Mode Menu, Battle Mode 2.0, "Real Clash", Track Player, Dual Mode Sounds Ignition, Spoken Battery Level / Colors, Hybrid Force / Quote Player, Rehearsal / Choreography Mode, Gesture Sleep, Preset Menu, Volume Menu update

Features

• 100% open-source, you may add any feature you like. (GPLv3)
• Support for WebUSB for configuration through a browser.
• Thermal Detonator support
• Blaster support
• MICOM suit sound prop
• Support for remote control via bluetooth (with external addon)
• Speedy 32-bit processor makes advanced features like sound filters, synthesizing and mp3 playback possible.
• 16-bit digital output (12-bit for TeensySaber V1 and V2)
• S/PDIF or I2S output
• Default sample rate is 44kHz
• 22kHz and 11kHz samples are supported and upsampled to 44kHz automatically.
• Gapless playback, with 2.5ms cross-fade when you interrupt one sample to go to another.
• Polyphonic playback, currently configured for up to 5 simultaneous samples.
• Support for Ws281X, PL9823, SK68** or neopixel strings. (including RGBW)
• Support for APA102 and dotstar strings.
• Support for arbitrary 1/2/3/4/5/6-color stars/strings.
• Supports segmented string blades. (with flash string)
• Multi-blade support for dual and crossguard setups.
• Crystal chamber support.
• Power-level indicator with neopixel blade.
• OLED PLI display
• IR sending and receiving
• RFID support
• MTP support (drag-n-drop files from windows through USB connection)
• POV (persistance of vision) mode.
• Multiple blades. (at the same time)
• Accent LEDs. (also implemented as additional "blades".)
• Spoken error messages.
• Easy software updates.

Features:

- Live preset changing while blade is running (skips font.wav and preon).

- Battle Mode, gesture ignitions, and multi-blast based on fett263's work.

- Auto enter/exit multi-blaster block mode 

- Spoken Battery level, with percentage option.

- Added quote sound so force.wavs can remain as force.

             - Add quote.wav files to font to use.

- Play / Stop track control while blade is on.

- Force Push is always available, not just in Battle Mode.

- Melt is always available as no button, with pull-away or button to end.

- Drag is always clash with button pressed while pointing down.

- No blade = no gestures option if Blade Detect is used.

- Use wav files for talkie things.

- Optional On-the-fly volume controls with cycle through min and max levels.

Optional Blade style elements:

On-Demand battery level - A layer built into the blade styles that reacts 

                          as the battery gets weaker, changing blade color 

                          from Green to Red, and the blade length shortens:

EFFECT_USER1            - use as a standalone trigger for EffectSequence<>,

                          for example as a way to have multiple blade styles in one preset.

                        - Usage:EffectSequence<EFFECT_USER1, item1, item2...>

                        - Custom swap.wav files can be used as the sound effect,

                          otherwise ccchange.wav is used.

EFFECT_USER2            - for blade effects with sounds that might work better without hum,

                          this plays sounds monophonically.

                          (think seismic charge silence, iceblade etc...)

                        - monosfx.wav files are used. It can be just the sound, or a

                          blade effect too by using EFFECT_USER2 in a TransitionEffectL.

Optional #defines:

#define ENABLE_AUTO_SWING_BLAST - Multi-blast initiated by simply swinging

                                  within 1 second of last blast.

                                  Exit by not swinging for 1 second.

#define VOLUME_MENU_CYCLE       - This allows the Volume menu to loop through from

                                  maximum back to minimum and vice versa.

#define FEMALE_TALKIE_VOICE     - To use a female voice version of onboard Talkie.

#define NO_VOLUME_MENU          - Option to omit On-the-fly Volume menu control with buttons.

---------------------------------------------------------------------------

Gesture Controls:

- There are four gesture types: swing, stab, thrust and twist.

  For simplicity, using gesture ignition will automatically skip the preon effect.

  Below are the options to add to the config to enable the various gestures:

#define BC_SWING_ON

#define BC_STAB_ON

#define BC_THRUST_ON

#define BC_TWIST_ON

#define BC_TWIST_OFF

#define NO_BLADE_NO_GEST_ONOFF

- If using blade detect, Gesture ignitions or retractions are disabled.

  **NOTE** Only works when a BLADE_DETECT_PIN is defined. 

#define BC_FORCE_PUSH

- This mode plays a force sound (or force push sound if the font contains it) with

  a controlled pushing gesture, and is always available, not just in Battle Mode.

#define BC_FORCE_PUSH_LENGTH

- Used for adjustment to the Push gesture length in millis needed to trigger

  Force Push. Recommended range 1 ~ 10,

  1 = shortest, easiest to trigger, 10 = longest. Default value is 5.

#define BC_GESTURE_AUTO_BATTLE_MODE

- Makes gesture ignition ALSO enter battle mode automatically on ignition.

"Battle Mode 1.0" by fett263, BC modified version:

- Once you enter battle mode, buttons are not used for lockup.

  Clashing the blade against something will automatically do lockup and then end

  when you pull away.

- Automatic lockup and grazing clash (swinging through) detection works

  by measuring delay of the saber blade pulling back from the clash.

  If you clash the blade and it does not pull back during the delay period,

  it is assumed to be a lockup and the lockup effect will show on the blade.

  If you clash the blade and pull away, only the bgn/end lockup effects will show.

  You can adjust the threshold of this detection by using:

#define BC_LOCKUP_DELAY (insert number here)

  Default value is 200.

  If you don't rebound off the object (opponent's blade) but instead clash while

  swinging through, clash will automatically trigger.

- To manually override the auto-lockup temporarily and get a regular clash,

  hold any button while clashing.

- Automatic clash/lockup uses the pre and post lockup effects

  so your blade style and font MUST have those capabilities to support

  battle mode.

- Melt will automatically trigger with no buttons when you physically

  stab something, and end when you pull away or push any button.

- Stab will trigger either with no buttons and thrusting forward,

  or with any button and physically stabbing something.

====================== 1 BUTTON CONTROLS ========================

| Sorted by ON or OFF state: (what it's like while using saber) |

=================================================================

*************   WHILE SABER BLADE IS OFF   ***************

Turn blade ON         - Short click POW (or gestures if defined, uses FastOn)

Turn ON without preon - Short click POW while pointing up.

Turn blade ON Muted   - 4x click and hold POW.

Next Preset           - Long click and release POW.

Prev Preset           - Double click and hold POW, release after a second.

                        (click then long click)

Play/Stop Track       - 4x click POW.

Volume Menu:

        Enter/Exit    - Hold POW + Clash.

        Volume UP     - Long click and release POW while in Volume Menu. (just like next preset)

        Volume DOWN   - Double click and hold POW, release after a second while in Volume Menu.

                        (click then long click, just like next preset)

Spoken Battery Level

        in volts      - Triple click POW.

        in percentage - Triple click and hold POW.

On-Demand Batt Level  - Double click POW.

                        (requires EFFECT_BATTERY_LEVEL to be in blade style,

                        and uses battery.wav sound effect.)

*************   WHILE SABER BLADE IS ON   ****************

Play/Stop Track       - 4x click POW.

Next Preset           - Long click and release POW while pointing up.

Prev Preset           - Double click and release POW after a second

                        while pointing up. (click then long click)

Clash                 - No buttons, just hit the blade against something.

                        In Battle Mode, Hold POW and Clash to temporarily

                        override the auto-lockup and do regular Clash.

Stab                  - Either no button and just Thrust forward,

                        or Hold any button and physically stab something.

                        Works in Battle Mode!

Blaster Blocks        - Click or Double click POW.

Auto Swing Blast      - if #define ENABLE_AUTO_SWING_BLAST is active,

                        swinging within 1 second of doing button activated 

                        Blaster Block will start this timed mode.

                        To trigger auto blaster blocks, swing saber

                        within 1 second of last Swing Blast block.

                        To exit, stop swinging for 1 second.

Lockup                - Hold POW + Clash.

                        In Battle Mode, just Clash and stay there,

                        pull away or press POW to end lockup.

Drag                  - Hold POW + Clash while pointing down.

Melt                  - No button, just stab something. pull away or

                        press POW to end.

Lightning Block       - Double click and hold POW.

Battle Mode           - Triple click and hold POW to enter and exit.

                        Power OFF is disabled while in Battle Mode,

                        YOU MUST EXIT THE MODE WITH THIS COMBO FIRST.

Force Effect          - Hold POW + Twist. (while NOT pointing up or down)

Monophonic Force      - Hold POW + Twist. (while pointing up)

Color Change Mode     - Hold POW + Twist. (while pointing down)

                        - Rotate hilt to cycle through all available colors, or

                        - Click POW to change if ColorChange<> used in blade style,

                        - Click + hold POW to save color selection and exit.

                        - Triple click POW to exit without changing color.

    ColorChange explained:

          If the style uses ColorChange<>, when you activate color change mode,

          there will be up to 12 steps per rotation with a little sound at each step.

          If it does not use ColorChange<>, the color wheel will be activated,

          which has 32768 steps per rotation.

          COLOR_CHANGE_DIRECT makes it so that IF the style uses ColorChange<>,

          when you activate color change mode, it will immediately go to the

          next color and exit color change mode. If the style does not use

          ColorChange<>, it has no effect.

Quote Player          - Triple click POW.

Force Push            - Push hilt perpendicularly from a stop.

Swap (EffectSequence) - 4x click and hold POW medium. (while NOT pointing up)

PowerSave Dim Blade   - 4x click and hold POW medium. (while pointing up)

          (To use Power Save requires AlphaL based EffectSequence in style)

Turn off blade        - Hold POW and wait until blade is off,

                        or Twist if using #define BC_TWIST_OFF.