-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Resources
Internal resources are in a binary file, for example icons
Alias | IO Access | User Access |
---|---|---|
QRC |
Read | - |
Platform | Path |
---|---|
Windows |
:/ (or qrc:// as url) |
MacOS |
:/ (or qrc:// as url) |
Linux |
:/ (or qrc:// as url) |
The default path for installing the program
Alias | IO Access | User Access |
---|---|---|
INSTALL |
Read | Private |
Platform | Path |
---|---|
Windows | |
MacOS | default for released versions is /Applications/ , but can be anywhere |
Linux | for AppImage is like /tmp/.mount_MuseXXXXXX , creating on app run |
Default resources of the program, for example default locale, soundfonts, templates and etc.
Alias | IO Access | User Access |
---|---|---|
APPDATA |
Read | Private |
Platform | Path |
---|---|
Windows | |
MacOS | $INSTALL/mscore/Contents/Resources |
Linux | $INSTALL/share/MuseScore[Version] |
Path to the program settings file
Alias | IO Access | User Access |
---|---|---|
APPCONFIG |
ReadWrite | Private |
Platform | Path |
---|---|
Windows | |
MacOS | $HOME/Library/Preferences/ |
Linux | $HOME/.config/MuseScore/ |
User resources of the program, for example installed locales, plugins, credentials and etc.
Alias | IO Access | User Access |
---|---|---|
USERAPPDATA |
ReadWrite | Private |
Platform | Path |
---|---|
Windows | %LOCALAPPDATA%\MuseScore\MuseScore[Version] |
MacOS | $HOME/Library/Application Support/MuseScore/MuseScore[Version] |
Linux | $HOME/.local/share/MuseScore/MuseScore[Version]/ |
User resources, for example user scores, templates and etc.
Alias | IO Access | User Access |
---|---|---|
USERDATA |
ReadWrite | Public |
Platform | Path |
---|---|
Windows | |
MacOS | $HOME/Documents/MuseScore/ |
Linux | $HOME/Documents/MuseScore/ |
The configuration file, which stores the program settings
Type | Path | Change path | IO Access | MI Sync |
---|---|---|---|---|
default | - | - | - | - |
user | $APPCONFIG/MuseScore[Version].ini | no | RW | yes |
user (macOS) | $APPCONFIG/org.musescore.MuseScore[Version].plist | no | RW | yes |
Localization files
Type | Path | Change path | IO Access | MI Sync |
---|---|---|---|---|
default | $APPDATA/locale/ | no | R | no |
user | $USERAPPDATA/locale/ | no | RW | yes |
The locale files cannot be changed, but new ones can be downloaded and replace the current. And also the state file is stored there, it can change while the program is running.
Shortcuts settings file and midi mapping
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | $QRC/shortcuts.xml | no | R | no |
user | $USERAPPDATA/shortcuts.xml | ? | RW | yes |
Midi mapping settings file
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | - | - | - | - |
user | $USERAPPDATA/midi_mapping.xml | ? | RW | yes |
Workspaces settings file
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | $APPDATA/workspaces/ | no | R | no |
user | $USERAPPDATA/workspaces/ | no | RW | yes |
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | - | - | - | - |
user | $USERAPPDATA/extensions/ | ? | RW | yes |
The files cannot be changed, but new ones can be downloaded and replace the current.
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | - | - | - | - |
user | $USERAPPDATA/plugins/ | ? | RW | yes |
The files cannot be changed, but new ones can be downloaded and replace the current.
Instruments settings file
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | $APPDATA/instruments/instruments.xml | no | R | no |
default | $APPDATA/instruments/orders.xml | no | R | no |
user | ? | ? | ? | ? |
Styles settings files
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | $APPDATA/styles/* | no | R | no |
user | ? | ? | ? | ? |
SoundFonts files
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | $APPDATA/sound/ | no | R | no |
user | ? | yes | R | no |
Templates files
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
default | $APPDATA/templates/* | no | R | no |
user | ? | ? | ? | ? |
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
user | $USERAPPDATA/cred.dat | no | RW | yes |
Logs and dumps files
Type | Path | Change path | Open Mode | MI Sync |
---|---|---|---|---|
user | $USERAPPDATA/logs/ | no | W | no |
user | $USERAPPDATA/logs/dumps/ | no | W | no |
Testing
- Manual testing
- Automatic testing
Translation
Compilation
- Set up developer environment
- Install Qt and Qt Creator
- Get MuseScore's source code
- Install dependencies
- Compile on the command line
- Compile in Qt Creator
Beyond compiling
Misc. development
Architecture general
- Architecture overview
- AppShell
- Modularity
- Interact workflow
- Channels and Notifications
- Settings and Configuration
- Error handling
- Launcher and Interactive
- Keyboard Navigation
Audio
Engraving
- Style settings
- Working with style files
- Style parameter changes for 4.0
- Style parameter changes for 4.1
- Style parameter changes for 4.2
- Style parameter changes for 4.3
- Style parameter changes for 4.4
Extensions
- Extensions overview
- Manifest
- Forms
- Macros
- Api
- Legacy plugin API
Google Summer of Code
References