Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New saber_sabersense_buttons.h Prop File Request #717

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Sabersense-CC
Copy link

INTRODUCING THE UPDATED SABERSENSE™
LIGHTSABER SWITCH CONTROL SYSTEM

OVERVIEW
The Sabersense Button System has been engineered with simplicity in mind. It is designed to be very easy to use, bomb-proof and consistent in terms of ‘rules’. It doesn’t require a ‘knack’ to access certain features, and it avoids tricky combinations like holding a button while simultaneously twisting or making other active gestures which can be difficult to execute.

HARMONIZED ONE-BUTTON AND TWO-BUTTON CONTROLS
By default, basic features like normal ignition, track playing, force effects, mute ignition, quotes etc. all have the same button controls on both one-button and two-button setups. This means users with large hilt collections which include one-button and two-button sabers don’t need to remember different sets of controls for these core features.

CONSISTENT ‘RULES’
This again means the user has less to remember. For example, one click of POWER with blade off always lights the blade - short click for normal, long click for muted; double clicking POWER always plays a sound effect - track, character quote or force effect depending hilt status (see next paragraph). This is all intended to make it easier to remember the various controls.

COMPREHENSIVE SOUND FONT NAVIGATION
One-button and two-button setups both allow users to move forwards or backwards one font at a time, or to skip to first font, last font or middle font. Two-button setups include additional navigation features which allow the user to skip forwards or backwards five and ten fonts at a time.

SEPARATE FORCE EFFECT AND CHARACTER QUOTE PLAYER
This allows users to access separate force effects, character quotes and music tracks depending on hilt orientation and status. Tracks can be pIayed with the blade OFF, hilt pointing down, Force effects can be played with blade ON, hilt pointing down, and Character Quotes can be played in both blade ON and OFF states with hilt pointing up. If desired, these orientations can be reversed using #define SABERSENSE_FLIP_AUDIO_PLAYERS. Character Quotes are always played sequentially while Force Effects are played randomly.

ON DEMAND BLADE ID AND MANUAL ARRAY SELECTOR
This allows users to run Blade ID on demand with a button press, eliminating potential blade ID scan errors that might occur under constant automatic scanning when blades are lit. Alternatively the BladeID engine can be reconfigured with a simple define allowing you to cycle through all blade and preset arrays manually, regardless of the actual BladeID status. This is useful if you have a number of different blades, for instance, that all return the same BladeID values and therefore cannot be differentiated by the system. Alternatively it can be used to divide sound fonts into separate arrays; for instance all light side fonts could be on array 1, all dark side fonts on array 2 and all diagnostic and engineering fonts on array 3.

RESTORE 'FACTORY' DEFAULTS
If you've ever found yourself stuck with settings changes you don't like, you will appreciate this feature. Using a simple, but unlikely, button press (to prevent accidental triggering) the system will delete all user-modified settings such as volume, blade colour and font selection and revert to the settings that were uploaded onto your saber.

OPTIONAL BUTTON ‘CLICKER’ DEFINE
For hilts that have buttons with poor tactile feedback (KR’s Scavenger for instance, with the emitter wheel button setup), simply adding a press.wav and release.wav of a clicking sound to the appropriate font folder, and including the #define SABERSENSE_BUTTON_CLICKER in your config will play those effects with their respective button actions to aid in feature navigation. Suitable wav files are included to download from the Sabersense website.

INTRODUCING THE UPDATED SABERSENSE™
LIGHTSABER SWITCH CONTROL SYSTEM

OVERVIEW
The Sabersense Button System has been engineered with simplicity in mind. It is designed to be very easy to use, bomb-proof and consistent in terms of ‘rules’. It doesn’t require a ‘knack’ to access certain features, and it avoids tricky combinations like holding a button while simultaneously twisting or making other active gestures which can be difficult to execute.

HARMONIZED ONE-BUTTON AND TWO-BUTTON CONTROLS
By default, basic features like normal ignition, track playing, force effects, mute ignition, quotes etc. all have the same button controls on both one-button and two-button setups. This means users with large hilt collections which include one-button and two-button sabers don’t need to remember different sets of controls for these core features.

CONSISTENT ‘RULES’
This again means the user has less to remember. For example, one click of POWER with blade off always lights the blade - short click for normal, long click for muted; double clicking POWER always plays a sound effect - track, character quote or force effect depending hilt status (see next paragraph). This is all intended to make it easier to remember the various controls.

COMPREHENSIVE SOUND FONT NAVIGATION
One-button and two-button setups both allow users to move forwards or backwards one font at a time, or to skip to first font, last font or middle font. Two-button setups include additional navigation features which allow the user to skip forwards or backwards five and ten fonts at a time.

SEPARATE FORCE EFFECT AND CHARACTER QUOTE PLAYER
This allows users to access separate force effects, character quotes and music tracks depending on hilt orientation and status. Tracks can be pIayed with the blade OFF, hilt pointing down, Force effects can be played with blade ON, hilt pointing down, and Character Quotes can be played in both blade ON and OFF states with hilt pointing up. If desired, these orientations can be reversed using #define SABERSENSE_FLIP_AUDIO_PLAYERS. Character Quotes are always played sequentially while Force Effects are played randomly.  

ON DEMAND BLADE ID AND MANUAL ARRAY SELECTOR
This allows users to run Blade ID on demand with a button press, eliminating potential blade ID scan errors that might occur under constant automatic scanning when blades are lit. Alternatively the BladeID engine can be reconfigured with a simple define allowing you to cycle through all blade and preset arrays manually, regardless of the actual BladeID status. This is useful if you have a number of different blades, for instance, that all return the same BladeID values and therefore cannot be differentiated by the system. Alternatively it can be used to divide sound fonts into separate arrays; for instance all light side fonts could be on array 1,  all dark side fonts on array 2 and all diagnostic and engineering fonts on array 3.

RESTORE 'FACTORY' DEFAULTS
If you've ever found yourself stuck with settings changes you don't like, you will appreciate this feature. Using a simple, but unlikely, button press (to prevent accidental triggering) the system will delete all user-modified settings such as volume, blade colour and font selection and revert to the settings that were uploaded onto your saber.

OPTIONAL BUTTON ‘CLICKER’ DEFINE
For hilts that have buttons with poor tactile feedback (KR’s Scavenger for instance, with the emitter wheel button setup), simply adding a press.wav and release.wav of a clicking sound to the appropriate font folder, and including the #define SABERSENSE_BUTTON_CLICKER in your config will play those effects with their respective button actions to aid in feature navigation. Suitable wav files are included to download from the Sabersense website.
A couple of comments made lines more than 100 characters - now sorted.
A couple of tiny clarification tweaks to user guide comments at top - no changes to actual code.
Sorry - just a few more minor comment tweaks for clarity, plus a couple of rogue tabs I spotted. No changes to actual code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant