V5 User Guide on the way

Hi @zynthianers!

this was already published in the V5 thread, but i prefer to put it in a separate thread so it’s easier to find and nobody miss it

For those having one of the new V5 units and for those curious about how the new V5 user interface works, here is the link to the V5 user guide:

https://wiki.zynthian.org/index.php/Zynthian_UI_User_Guide_-_V5

It’s a work in progress and it will improve along the next days/weeks. In its current state is a good introduction and it will solve many doubts. Indeed, those coming from the classic zynthian UI will find it very enlightening.

Don’t hesitate to ask your doubts and give your opinion about it.

For the rest of the guide, i’ve a nice surprise i’ve been working on and i’m pretty sure all of you will be really pleased with it.

Enjoy!

12 Likes

Thank you @jofemodo !

Hi @zynthianers!

I’ve been working in a “web zynthian mockup” that is capable of replaying pre-captured zynthian sessions:

You can test it on-line:

https://zynthian.org/mockup/index.html?capture=Zynthian_V5_UI:_Basic_Concepts

and very soon it will be integrated in the webconf, so everybody could capture small tutorials and share with others.

For the curious, the zynthian-ui’s “capture_log” branch is the development branch that implements the session capture functionality. The subtitles must be added by hand, but this will change when the mockup player is integrated in the webconf.

Currently, only V5 mockup has been implemented, but creating a mockup for V4, V3, etc. will be really easy after creating this beauty!

Of course, i know what some of you are thinking right now…

  • why not to embed the VNC display instead of replaying a video?
  • why no to send the events in real time from the zynthian to the mockup using a websocket?
  • why not to send button & knob events from the browser to the zynthian?
  • etc.

:grin: :nerd_face:

All this will be implemented too … but not today!!
And of course, i hope somebody step forward for this task. I’m tired of web development and i would like to focus in the 64 bit migration.

Enjoy!!

8 Likes

This is quite slick, I think no one will use the wiki after they start to see this :laughing:

1 Like

Yes it is pretty cool but I don’t think it replaces a searchable text document. Some of us oldies prefer to read some info rather than sit through a video tutorial. There are places for both and good (accurate and easy to comprehend) documentation is very advantageous.

The virtual Zynthian is truly a step forward in our tools to educate. Well done @jofemodo.

3 Likes

Hi @zynthianers!

The v4 is ready too:

You can test it on-line too:

https://zynthian.org/mockup/index.html?capture=ui_sesion-20230814-v4

  • The workflow capture option is integrated in the zynthian-ui (testing branch). You will find it at the end of the admin menu.

  • The mockup player is fully integrated in the webconf (testing branch). You can access the captured workflow sessions (logs) from the library->capture panel, under the “log” tab.

The webconf mockup player also allows to edit the subtitles (add, delete, save, etc.) Changing the log file name will modify the title too.

Please, play a little bit with it. It’s not perfect but it reached a sweet point and it starts to be useful.

I hope to start releasing some curated workflow captures with nice subtitles in the next days, specially for V5. Perhaps some of you want to do the same with the V4?

Enjoy!

6 Likes

Awesome!

Very cool - but how can I export that to i.e. Youtube? Screenrecording needed? I can see an MP4 embedded, but that is only the screen.

Yes. For exporting to YouTube you should use a screen recorder.

2 Likes

About to download Release OBS Studio 29.1.3 · obsproject/obs-studio · GitHub
Fine - I think about re-recording my tutorial and integrating that.

1 Like

Hi @zynthianers!

The “capture workflow” feature from the admin menu, now captures the audio output too. This is a killer feature that allows recording “workflow tutorials” with very little effort.

  • Connect a microphone to your zynthian and create an audio chain so you can hear your voice in the output. Don’t add too much delay or echo so people can understand what you say :wink:

  • Check “capture workflow” in the admin menu. Your zynthian will start to record all UI actions, display contents and audio output.

  • Do something interesting with your zynthian while speaking, explaining what are you doing, etc. Don’t go too fast!!

  • When finished, uncheck “capture workflow”.

  • Access webconf->captures. Your workflow captures will be listed in the “log” folder, like this:

  • Click the session you want. You can replay the capture by clicking the “Play in Mockup” button, at right.

  • From the Mockup Player, you can also add subtitles!!

  • When ready, you can use a screen video grabber to generate a MP4 video to share.

Enjoy … and share your knowledge!!

11 Likes

Amazing great job :clinking_glasses:

Will you please describe how to use this feature? I have not worked out how you add subtitles for different periods of the playback.

[Edit] Through trial and error I think you do this:

  • Click the blue edit button
  • Position the cursor to where you want the title to start
  • Click the + button
  • Enter the title text
  • Repeat for each new title
  • Add blank title to restrict the duration of previous title
  • Position cursor within a title period then press X button to remove it
  • Click the button to finish

When you know how it works it becomes simple but it is not necessarily intutive. There are no tooltips for the buttons. You can’t see where titles are (especially blank ones) in the timeline. This is a super cool thing that I applaud, yet it could be even better!

3 Likes

Yes! You catch it! We need to add this description to the tool and also marks in the timeline.
It will be better!

Thanks

3 Likes

I am getting to like workflow capture…

Can a log file re render against a more recent version oram and reflect the new changes in the interface…?

So if a new menu item has appeared will it track the correct location?

Hi,
I would suggest a minor improvement. I described them in the feature request:

1 Like

@riban
Thanks for the quick implementation. I tried it via midi Master Key Actions and it works.

1 Like

I have a few questions.
I tried to make an educational recording on how to turn on RPT-Midi and how to assign it to a new chain.
Unfortunately, my functional Zynthian is in the form of an RPI 400 and a 7" touch screen, which has an impact on the logging of actions in the log file.

I figured out that by changing the first line of LAYOUT, I would change the appearance in the mockup player.

For LAYOUT: DUMMY or V4
this sequence works (emulated by ENTER key on RPI 400 keyboard).

0:00:17.95 ZYNSWITCH:P,3
0:00:18.13 ZYNSWITCH:S,3

I assume that for the option LAYOUT: V5 it needs to be replaced by V5_ZYNPOT_SWITCH.

I assumed that commands like (recorded after press of keys on RPI 400):
CUIA:screen_admin,None
CUIA:screen_main_menu,None
CUIA:arrow_up,None
CUIA:arrow_down,None
they will be displayed on the respective mockup player buttons in the lLAYOUT: V5.
Just out of curiosity, what is their correct version?

@jofemodo , how did you make the text bold in the captures that are on the wiki?

And what procedure do we choose to publish the workflow capture on the wiki?

1 Like