API tools faq
paste
highlightshadow

GH3 Notes

highlightshadow
Dec 9th, 2021 (edited)
47
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 8.58 KB | None | 0 0
raw download clone embed print report
  1. Golden Harvest V3 notes
  2.  
  3. Last Updated: 10/12/2021
  4. Update History: 09/12/2021
  5.  
  6. SD Card is made up of several folders / files
  7.  
  8. Root: general.txt << core config file for the saber and defines:
  9. Button layout (1 / 2)
  10. Pixel / blade type / count
  11. Gestures in general
  12. Timings for buttons
  13. Sleep timings etc
  14.  
  15. override-general.txt << this contains values that have been amended in the saber - pixel count done using editor option. Gesture Control overrides
  16.  
  17. update.dat << Firmware updates come as a single file which goes onto the SD and then is erased when complete
  18.  
  19. Folders:
  20. UserInterfaceSounds << Basically all the sound effects for menus, voice prompts etc. Comes as part of the "Default Package" from Sabertec. You should update with new firmware version default files as they're delivered
  21.  
  22. SoundFonts << This is where all the actual fonts live that either include with default package or installed from 3rd party font makers. Can be either GH3 custom or CFX clones
  23. Sound Fonts are installed in here in the format "soundx - name" where x is a number in sequence and the name can be anything. Eg: sound1 - ANH_Training
  24. Inside each font are the files + 1 settings file:
  25. settings.txt << This contains parameters such as ignition speed, retraction speed (0 meaning follow the sound effect playtime). This file gets amended sometimes with firmware versions so occasionally you'll have to update all the settings.txt in your fonts with updated parameters
  26.  
  27. common << there's a folder inside the SoundFonts directory and has common pre-on and post-off sounds along with some tracks. These are updated with the default package and should be updated on your SD when delivered.
  28.  
  29. EffectFonts << This is where the default blade and color profiles are delivered. In here are 9 "slots", 1-6 are for baselit / RGB sabers and 7-9 are for Neopixel.
  30. The slot is chosen inside the general.txt file which instructs the board to look in the relevent slot.
  31. This is also where associations between colour, blade styles and soundfonts lives. For example, I'm using "slot9 - Neopixel Extended" which contains 36 different base blade profiles.
  32. This is also where things get more messy.
  33.  
  34.  
  35. In the root of EffectFonts are a series of prefs<x>.txt (x being a number such as prefs1.txt)
  36. This number corresponds to the sound<x> folder of the soundfont. This is where the primary mapping of Sound to Effect is made.
  37.  
  38. It will contain 5 values, the 2 accents can be ignored if you do not have accent pixels on your hilts:
  39. blade_profile=1
  40. color_profile=6
  41. on_top_effect=1
  42. standby_accent_profile=1
  43. ignited_accent_profile=1
  44.  
  45. blade_profile=1 <<< this means that inside slot9, it'll use blade1 - Classic1 for it's base, effect and colour wheels
  46. Inside each blade<x> folder are 4 sets of files:
  47. background.txt << this defines the core blade "look" such as a flicker, wave, pulse, flow, sauron etc
  48. colou<1-12>.txt << these contain the individual colour palettes including base colour, flash, lockup, melt, drag, blast etc
  49. ontop<1-28>.txt << these contain additioal "looks" that overlay the base blade style -- will include things like unstable, scrolling pulses, flickers, flashes etc
  50.  
  51. So in the above example, it's using "blade1 -Classic1" as it's source of effects and then ontop1.txt and colour6.txt for the colour pallete
  52.  
  53. In essence all the 36 blade folders contain identical ontop and color files (meaning each blade style can have the same colour wheels and effects)
  54. Liekly you'll want to keep all these aligned for simplicity.
  55.  
  56. However, there's "override" files inside the blades folders, if you amend a colour of a accent in the saber editor you're not amending the base colorx.txt file, you're creating an override for that colour slot.
  57. So if you changed a blaster colour from red to green for example and this was inside color1.txt, that file will now have a corresponding override-color1.txt
  58. Any time you then pick blade1 and color1 for any other soundfont you'll start from the same override starting point, if you then change those colors you'll affect ANY other blade using the same blade & color combination.
  59.  
  60. This is why sometimes people choose to copy the styles/colors they want to amend into a whole other slot, such as slot10 - Custom to house any changes they've made
  61.  
  62. =======================================================================================================================================
  63. 10/12/2021 - Update 1
  64. =======================================================================================================================================
  65.  
  66. Update based on playing around with the board more and getting my head around the file structures which are complex but also repetative.
  67.  
  68. For reference, in my general.txt it's using slot9 - Neopixel Extended effects folder
  69.  
  70. In that slot9 folder there's 7 sets of effect fonts:
  71. Blades 1 - 6: Classic << these are generally canon gentle flickers.
  72. Blades 7 - 13: Frozen << these are generally repeating patterns of small blocks moving around the blade
  73. Blades 14 - 22: Wave << These are generally blocks of patterns scrolling down the blade in repeating patterns
  74. Blades 23 - 26: Colour Flow << These are generally rainbow blades
  75. Blades 27 - 31: Flame << Simulating fire along the blade
  76. Blades 32 - 33: Sauron << A focussed black-spot in the centre of the blades ripping outwards
  77. Blades 34 - 35: Gradient << Gradual colour change along the blade
  78. Blade 36 : Dark << Dark Saber effect (ripples gently)
  79.  
  80. Inside each of these "blade" folders are a set of files:
  81. background.txt - This is the main base effect definition of the blade. Including all phases of the blade. Ignition, main effect, clash, block, blaster etc etc. Each section has a bunch of parameters which tell GH how to behave on that base level.
  82. blade.wav - This is the voice announce of the blade such as "Classic One"
  83. color1-12.txt - These are the colour profiles. Each phase of the blade (ignition, base, clash, blaster etc) has a colour defined for it
  84. ontop1-28.txt - These are the enhancements that add a second layer of effects over the base style. This inludes things like white pulses, different colour flickers, flashes, unstable blade effects. This is how GH3 makes it's myriad of combinations since you essentially have 36 "blades" and each has 28 ontop overlays meaning out of the box you have 1008 combinations of base blades & ontop effects.
  85.  
  86. Example - You could have a classic1 base blade which is just solid colour "background" and then one of the unstable "ontop" effects to get a reasonable unstable blade. But if you choose something like Wave and an unstable you get a more agressive end result of unstable.
  87.  
  88. override-color1.txt (number depends on which is edited). This is where one of the complexities arise.
  89. When you pick a blade profile that then dictates that you're using the color files inside that blade directory. When you pick the colour profile you're picking from the color1-12.txt files inside the blade directory. Essentially the ontop and color files are (by default) repeated in all the blades
  90. For this example, lets say you're using blade1 - classic and color1 profile inside.
  91. If you then change (in saber editor) a part of the colour profile (say it's a shade of red but you change it to more pink or purple), the result is a new file inside the blade1-classic folder called override-color1.txt - this contains all color definitions for all the different effects but with the new value(s) that you might have picked in saber editor.
  92.  
  93. So now, anytime, for any soundfont, you pick that same blade (1 - classic) and color profile combination you'll be using the override colors from that new file. Conversely, if you then amended that color again in this new font, you're then essentially affecting any other soundfont setup to use that same blade/color combo.
  94.  
  95. So that's the blade folders and their content.
  96. Inside the slot9 folder there's then a set of pref<X>.txt, the files are numbered to reflect with the soundfont folders in the Soundfonts main folder. This is where the link between soundfont & effectfont live.
  97.  
  98. The prefs file is short, just 6 lines, each associating the blade, color, ontop and accent effects (accent being additional LED strips, accent pixels or potentially shtok connector depending on how it's been wired)
  99.  
  100. blade_profile=1 << This is the blade<x> folder that the soundfont will get it's effect from
  101. color_profile=8 << This is the color profile from inside the blade folder that the soundfont will use
  102. on_top_effect=1 << This is the overlay/ontop effect that modifies the base blade
  103. standby_accent_profile=1
  104. ignited_accent_profile=1
  105.  
  106.  
  107.  
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!