educandu-plugin-mei-studio

An educandu plugin to import MEI (Music Encoding Initiative) files and display musical notation.

Prerequisites

• node.js ^20.0.0
• optional: globally installed gulp: npm i -g gulp-cli

The output of this repository is an npm package (@musikisum/educandu-plugin-mei-studio).

Installation

npm install @musikisum/educandu-plugin-mei-studio

Usage

Add the plugin info to the application's custom resolvers module:

import MeiStudioPlugin from '@musikisum/educandu-plugin-mei-studio';

export default {
  resolveCustomPageTemplate: null,
  resolveCustomHomePageTemplate: null,
  resolveCustomSiteLogo: null,
  resolveCustomPluginInfos: () => [MeiStudioPlugin]
};

Add the plugin name and its translations to your server config (no additional controller is needed - the plugin has no server-side code):

import educandu from '@educandu/educandu';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const meiStudioPluginTranslationsPath = require.resolve('@musikisum/educandu-plugin-mei-studio/translations.json');

educandu({
  plugins: [/* your other plugins here */, 'musikisum/educandu-plugin-mei-studio'],
  resources: [/* your other translations here */, meiStudioPluginTranslationsPath],
  /* your other server config here */
});

Import the plugin styles to your main LESS entry point:

// Base styles from Educandu:
@import url('@educandu/educandu/styles/main.less');

// Styles for the plugin:
@import url('@musikisum/educandu-plugin-mei-studio/mei-studio.less');

// Other styles here

Development

git clone [email protected]:musikisum/educandu-plugin-mei-studio.git
cd educandu-plugin-mei-studio
yarn install
npx gulp

OER learning platform for music

Funded by 'Stiftung Innovation in der Hochschullehre'

A Project of the 'Hochschule für Musik und Theater München' (University for Music and Performing Arts)

Project owner: Hochschule für Musik und Theater München
Project management: Ulrich Kaiser