How to use?

[Erhannis]

It's great to have API documentation, info on how to contribute, and all, but none of it gives a good idea how to USE the code. Is there an example, somewhere? A tutorial?

Related - I get the impression this code is supposed to visually render music, but I haven't yet figured out which class does it, and how.

[otsob]

Unfortunately there are no examples yet, they would definitely be useful so I will aim to create some at some point. Wmn4j is mainly intended for handling the content of music notation, e.g., for analysis, so there is no rendering and probably will not be in the near future. The idea is that with being able to output MusicXML, the rendering could be taken care of by any SW able to render notation from MusicXML.

[Erhannis]

Ah, ok; thank you. Would you happen to know any good MusicXML renderers?

Also, I made some test code; lemme know if I'm doing something wrong, and if not, feel free to copy it into an example file or the README or whatever, if you want.

ScoreBuilder sb = new ScoreBuilder();
sb.addPart(new PartBuilder("melody")
        .add(new MeasureBuilder()
                .setClef(Clef.of(Symbol.G, 2)) // I don't know which line this is supposed to center on
                .setTimeSignature(TimeSignature.of(4, 4))
                .addToVoice(0, new RestBuilder(Duration.of(1, 4)))
                .addToVoice(0, new NoteBuilder(Pitch.of(Pitch.Base.C, Pitch.Accidental.NATURAL, 4), Duration.of(1, 4)))
                .addToVoice(0, new ChordBuilder(Arrays.asList(
                        new NoteBuilder(Pitch.of(Pitch.Base.C, Pitch.Accidental.NATURAL, 4), Duration.of(1, 2)),
                        new NoteBuilder(Pitch.of(Pitch.Base.E, Pitch.Accidental.NATURAL, 4), Duration.of(1, 2)),
                        new NoteBuilder(Pitch.of(Pitch.Base.G, Pitch.Accidental.NATURAL, 4), Duration.of(1, 2))
                )))
        )
);
Score score = sb.build();
try {
    MusicXmlWriter.writerFor(score, new File("example.xml").toPath()).write();
} catch (IOException ex) {
    Logger.getLogger(MainFrame.class.getName()).log(Level.SEVERE, null, ex);
}

[otsob]

I think you can render MusicXML with MuseScore and LilyPond. The code snippet looks right, except the G-clef line would typically be 2 when counting from bottom line upwards.

[Erhannis]

Ok, thanks. And ah - I've figured out that should be "xml" rather than "mxl", or few things will read it. Also I got the note durations wrong. I've edited both things (and the clef) in my previous comment.