Documentation for Developers - Jojo-Schmitz/MuseScore GitHub Wiki
Contents
1. Optional Settings and Components
1.1 Using Qt Designer to Edit .ui Items
-
Qt Designer can be used in standalone mode or via Qt Creator to edit .ui items seen in the solution.
-
To use standalone, simply open Qt Designer from the Windows start menu or via right-click on a .ui file and select "Open with".
-
To integrate Qt Creator into Visual Studio
- Right-click a .ui item in Visual Studio and select Open With...
- Select Add then enter the path of your Qt Designer bin folder
- Select Set as Default then press OK
- .ui items will now open in Qt Designer from within Visual Studio
2. Links to Learning Materials
2.1 GitHub
- GitHub Docs Official documentation
- Git in Visual Studio 2022 from Microsoft Learn
- Git and Github Tutorial for Beginners A 12-part series of short YouTube videos.
2.2 CMake
2.3 MuseScore 3.x
- MuseScore Developers' Handbook: Git Workflow
- MuseScore Developers' Handbook: Exploring Code and Data Structures
- MuseScore Developers' Handbook: Coding Rules
- MuseScore Plugins API
2.4 Microsoft Visual Studio
2.5 Qt
- Qt Tutorial for Beginners - worth reading all of this short document
- Qt Documentaton
3. Tips & Tricks
3.1 Changing options in CMakeList.txt
Changing options in CMakeList.txt requires a re-build of the CMake cache.
-
In Microsoft Visual Studio 2022, from the Project menu select Delete Cache and Reconfigure.
-
See StackOverflow discussion: Disabling CMake option has no effect for more details.
3.2 Output debug messages to a file
In Win 11, Qt QDebug sends debug messages of the debug build to Terminal/conhost by default, which does not have "disable word wrap" option unlike previous cmd.
To write to a log file instead, edit
mscoreMessageHandler in mscore\musescore.cpp as suggested on https://stackoverflow.com/questions/4954140/how-to-redirect-qdebug-qwarning-qcritical-etc-output/11202102#11202102. Find it under out\install\x64-debug\bin or msvc.install_x64\bin.