Sabersense Prop Documentation by Sabersense-CC · Pull Request #66 · profezzorn/ProffieOSDocs

Sabersense-CC · 2025-03-11T17:16:47Z

I've added a sabersense folder to the prop page documentation with several pages of info on the main Sabersense Prop features.

I forgot to add a couple of features. Now done.

Array Selection explained.

Prof, this is all kind of a work in progress, but I need to GitHub editor to be able to check formatting. I'll message when everything is done if that's OK.

profezzorn

first pass...

profezzorn · 2025-03-11T17:46:59Z

props/sabersense/_introduction.md

@@ -0,0 +1,32 @@
+# Introducing the Sabersense Button System


POD pages should start with:

--- title: TITLE --- And the title should be fairly short.

Added to each page.

I think you want the title to be something like "SaberSense Prop Introduction" so that people know what it is an introduction to.

props/sabersense/array_selector.md

props/sabersense/_introduction.md

Now sorted.

Switching effects player functionality on and off.

Updated to include details about using Blade Detect at the same time as SABERSENSE_ARRAY_SELECTOR. Other beta features that have been abandoned also removed from documentation.

Speeling mishtaks fizzed.

Work in progress - ignore for now....

Sabersense-CC · 2025-04-23T08:09:57Z

OK, I've been through everything, updated it and tidied it up, and added one and two button user controls. :)
All finished and good to go. :)

profezzorn

Didn't actually make it through all the files yet...

profezzorn · 2025-06-26T05:41:17Z

props/sabersense/_introduction.md

@@ -0,0 +1,32 @@
+# Introducing the Sabersense Button System


I think you want the title to be something like "SaberSense Prop Introduction" so that people know what it is an introduction to.

profezzorn · 2025-07-01T05:38:39Z

props/sabersense/_introduction.md

+
+## Overview
+Built on Matthew McGeary’s SA22C setup, the Sabersense Prop File has been designed with simplicity in mind. It provides a saber control system that is intuitive, easy to use
+and consistent in terms of ‘rules’. It doesn’t require a ‘knack’ to access certain features, and tricky combinations like holding a button while simultaneously twisting or making other active gestures have been mostly removed. More complex features like Battle Mode are also not included.


no newlines in paragraphs

profezzorn · 2025-07-01T05:42:17Z

props/sabersense/_introduction.md

+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.
+
+## Blade ID Scanning On Demand
+This allows users to run blade ID with a button press, removing the need for continuous automatic scanning. More details can be found here: https://pod.hubbe.net/props/sabersense/blade_id


"removing the need for continuous automatic scanning" makes it sounds like continuous automatic scanning is bad for some reason?

Also, please use linked words or sentences instead of full URLs whenever possible.
Also, URLs don't need the hostname, in case that ever changes in the future.

Reworded, and all links updated.

profezzorn · 2025-07-01T05:44:34Z

props/sabersense/_introduction.md

+The Sabersense Button System has been written for, and is included with, ProffieOS 8.x or later. However it is also fully backwards compatible with ProffieOS 7.x as standard, with all the same features.
+
+## Free Sound Files
+The Sabersense Prop File uses certain sound files to aid feature navigation. Although not necessary for the system to work, these files are available as a free download from the Sabersense website. Visit www.sabersense.co.uk and navigate to *downloads*.


Why can't the link go directly to downloads?

profezzorn · 2025-07-01T05:44:57Z

props/sabersense/array_selector.md

@@ -0,0 +1,234 @@
+---
+title: Array Selector


Title ought to have SaberSense in it I think?

profezzorn · 2025-07-01T05:45:27Z

props/sabersense/array_selector.md

+title: Array Selector
+---
+
+# Array Selector Explained


Why not just make this the title?
Looks weird to have two titles.

Sorted on all pages.

profezzorn · 2025-07-01T05:46:06Z

props/sabersense/array_selector.md

+## Principles and Practice
+Array selection is a seemingly simple tool that is actually surprisingly powerful. The idea is that multiple different blade settings can be accessed at the press of a button, with simple config tweaks providing enormous options. Adjustments to the blade array can help build many different Array Selection setups, such as:
+
+- By specifying dummy blades, you can have a different number of effective blades on the same saber by switching arrays.


Hmm, I think * is normally used for bullet lists, not - ?

profezzorn · 2025-07-01T05:47:56Z

props/sabersense/array_selector.md

+# Array Selector Explained
+
+## Principles and Practice
+Array selection is a seemingly simple tool that is actually surprisingly powerful. The idea is that multiple different blade settings can be accessed at the press of a button, with simple config tweaks providing enormous options. Adjustments to the blade array can help build many different Array Selection setups, such as:


Might be worth mentioning that Array Selection is built on top of blade ID, so you can't really use array selection and blade ID at the same time.

Reworded accordingly.

All comments implemented.

Suggested changes implemented.

Doubled title removed.

Sabersense-CC added 16 commits March 11, 2025 09:34

Create _introduction.md

d0b1079

Update _introduction.md

5380722

I forgot to add a couple of features. Now done.

Create array_selector.md

6e03980

Array Selection explained.

More detail included

2cc567d

Prof, this is all kind of a work in progress, but I need to GitHub editor to be able to check formatting. I'll message when everything is done if that's OK.

More tidying...

eac9baa

Create blade_id.md

46ac257

Create restore_defaults.md

fb0972d

Create quote_force_track.md

5e0834f

More tidying...

2f34b67

More additions...

6b2aee6

Tweak

6f828cc

Typos...

587c1c7

Punctuation...

8abf256

Formatting

6dea981

Just learned a new formatting trick...

29cec14

Create button_clicker.md

1702795

profezzorn reviewed Mar 11, 2025

View reviewed changes

Sabersense-CC added 13 commits March 11, 2025 18:17

First Pass fix.

9960a27

First pass fix array selector

b1e5db6

First pass fix Blade ID

4a366ea

First pass fix button_clicker

0016c41

First pass fix quote_force_track

53cc86c

First pass fix restore_defaults

9f06117

Yikes - just saw code extracts indenting needed a tweak...

ad15cca

Now sorted.

Grammar and wording tweaks.

fad4dda

I thought of another implementation...

c21437f

Switching effects player functionality on and off.

Tweaks and typo fixed...

79d974b

Add instructions for Default Array and Blade Detect.

70ce141

Update OS-7 compatibility Comments...

db6669d

Update array_selector.md with new Blade Detect details

bc64591

Updated to include details about using Blade Detect at the same time as SABERSENSE_ARRAY_SELECTOR. Other beta features that have been abandoned also removed from documentation.

Sabersense-CC added 13 commits April 22, 2025 09:37

Update blade_id.md - Fixed Typos.

5543432

Speeling mishtaks fizzed.

Update array_selector.md - BD link added

22d02cd

Update restore_defaults.md - Grammar Fix

8b8e522

Merge branch 'profezzorn:main' into patch-1

0fe541c

Create Controls.md

0e0ff53

Work in progress - ignore for now....

Rename Controls.md to controls.md

d793dca

Update and rename controls.md to 2_btn_controls.md

d18d492

Create 1_btn_controls.md

006003d

Rename 1_btn_controls.md to controls_1_btn.md

0b04140

Rename controls_1_btn.md to _controls_1_btn.md

9710045

Rename 2_btn_controls.md to _controls_2_btn.md

4c6e945

Rename _controls_1_btn.md to user_controls_1_btn.md

a5380ac

Rename _controls_2_btn.md to user_controls_2_btn.md

a03132e

profezzorn reviewed Jul 1, 2025

View reviewed changes

Sabersense-CC added 10 commits July 1, 2025 08:27

Update _introduction.md

0ccc71e

All comments implemented.

Update array_selector.md

f33ab3e

Suggested changes implemented.

Update blade_id.md

d3afff8

Doubled title removed.

Update button_clicker.md

8eb0660

Doubled title removed.

Update quote_force_track.md

62cf663

Doubled title removed.

Update restore_defaults.md

1c2506d

Doubled title removed.

Update user_controls_1_btn.md

5acf803

Doubled title removed.

Update user_controls_2_btn.md

a862290

Doubled title removed.

Default Array Feature added

2f49720

Example tweak

4a468e7

Conversation

Sabersense-CC commented Mar 11, 2025

Uh oh!

profezzorn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Sabersense-CC commented Apr 23, 2025

Uh oh!

profezzorn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants