mixxxdj / manual

The Mixxx Manual
https://manual.mixxx.org/
52 stars 119 forks source link

add manual for Intech TEK2 #686

Open Greg-Orca opened 3 months ago

Greg-Orca commented 3 months ago

documentation for https://github.com/mixxxdj/mixxx/pull/13521

preview: https://deploy-preview-686--mixxx-manual.netlify.app/hardware/controllers/intech_tek2

ronso0 commented 3 months ago

Thank you for the documentation!

Currently it's written in the Intech perspective (we/us = Intech), would you mind to reword so it's more from the 'Mixxx/neutral perspective' like the other mapping documentations?

I'll make some suggestions. Feel free to adopt or rephrase. Or, if you don't have time to rework it, let us know. I could take care of it.

ronso0 commented 3 months ago

Please also document what the wheels and buttons control in this mapping.

ronso0 commented 3 months ago

I'm curious: what exactly does the GRID editor do? Does it configure the MIDI messages for each control? Can the LEDs be addressed by the Mixxx mapping without further configuration? (are they adressed by the Mixxx mapping?)

Greg-Orca commented 3 months ago

It's a fully configurable controller. With the grid editor, you can create any custom configs. This scratch mapping I created is just really basic because someone requested it in our Discord. I didn't have time to make a huge configuration yet, It takes me time (I am not a programmer). https://grid-editor-web.web.app/

ronso0 commented 3 months ago

Thanks for the webapp link, now I get it!

One more question: are the currently unused buttons also emitting MIDI with the 'TEK2 DJ setup'? (can tell because with virtual devices in the webapp, all MIDI channels/notes/values are unset) so that users can

I think that would lower the barrier to customize the TEK2 for Mixxx.

Greg-Orca commented 3 months ago

Yes, exactly. Users can map the other four buttons using the Mixxx mapping wizard. Additionally, if they want to extend the setup with another grid, they don't need to open the Grid Editor; they can just use the map wizard.

ronso0 commented 3 months ago

Yes, exactly. Users can map the other four buttons using the Mixxx mapping wizard. Additionally, if they want to extend the setup with another grid, they don't need to open the Grid Editor; they can just use the map wizard.

Alright, great. So let's add that to description here. (see my suggestion, sorry for not checking this during the first run)

Greg-Orca commented 3 months ago

@ronso0 I checked the two failed check, and the Links not failing because of TEK2 article. I'm not sure what is the PDF Manual and why is failing.

Swiftb0y commented 3 months ago

it can't find the pigure png for some reason :shrug: Maybe the PDF build is not configured/unable to deal with png's?

ronso0 commented 3 months ago

There are many other PNGs, that can't be it.

I tried building it locally with the instructions given at https://github.com/mixxxdj/manual?tab=readme-ov-file#to-build-a-translated-manual-in-a-particular-language make -e SPHINXOPTS="-Dlanguage=de" pdf gives me

make: *** No rule to make target 'pdf'. Stop.

ronso0 commented 3 months ago

Then I tried the command from the CI runner sphinx-build -b latex -q -j $(nproc) -Dlatex_engine=xelatex source build -> nothing logged, no PDF in /build/ anywhere

tried ./build_pdf.sh (and commented out all languages except en in /source/conf.py: -> logs a lot of font warnigns and exits with code 12, BUT does build a PDF, though no text, only pictures :laughing:

(all requirements installled)

ronso0 commented 3 months ago

Might indeed be related only to intech_tek2.png FWIW this is how it looks like in gThumb: image

Fix: open with Gimp, (do nothing), overwrite, and it looks good in gThumb, too. Maybe try that? (with Gimp or any other app)

ronso0 commented 3 months ago

(Later on it would be good to squash all commits)

Greg-Orca commented 3 months ago

It's strange, how is it possible? On Mac Preview, it looks good. Also, we use this picture on several websites

Screenshot 2024-08-08 at 12 13 07
ronso0 commented 3 months ago

I have no idea. Maybe various image viewers (like mediaplayers) are more tolerant wrt artefacts / file corruption? Just for testing, can you pick this image and commit? We can revert if necessary. intech_tek2.png

ronso0 commented 3 months ago

Okay, no it works so it was indeed something with the file encoding or whatever (tbh I'm not motivated to investigate further).

@Swiftb0y Okay to merge as soon as the mapping is ready?

Swiftb0y commented 3 months ago

yup, waiting for https://github.com/mixxxdj/mixxx/pull/13521 to mature. There are still open questions @Greg-Orca