simfile.ssc

Simfile & chart classes for SSC files.

Module Contents

Classes

SSCChart

SSC implementation of BaseChart.

SSCCharts

SSC implementation of BaseCharts.

SSCSimfile

SSC implementation of BaseSimfile.
class simfile.ssc.SSCChart

Bases: simfile.base.BaseChart

SSC implementation of BaseChart.

Unlike SMChart, SSC chart metadata is stored as key-value pairs, so this class allows full modification of its backing OrderedDict.

Adds the following known properties:

  • Metadata: chartname, chartstyle, credit, timesignatures

  • File paths: music

  • Gameplay events: tickcounts, combos, speeds, scrolls, fakes, attacks

  • Timing data: bpms, stops, delays, warps, labels, offset, displaybpm

chartname
chartstyle
credit
music
bpms
stops
delays
timesignatures
tickcounts
combos
warps
speeds
scrolls
fakes
labels
attacks
offset
displaybpm
notes
classmethod from_str(cls: Type[SSCChart], string: str, strict: bool = True) → SSCChart

Parse a string containing MSD data into an SSC chart.

The first property’s key must be NOTEDATA. Parsing ends at the NOTES (or NOTES2) property.

By default, the underlying parser will throw an exception if it finds any stray text between parameters. This behavior can be overridden by setting strict to False.

classmethod blank(cls: Type[SSCChart]) → SSCChart

Generate a blank, valid chart populated with standard keys.

This should approximately match blank charts produced by the StepMania editor.

serialize(self, file)

Write the object to provided text file object as MSD.

class simfile.ssc.SSCCharts(data=None)

Bases: simfile.base.BaseCharts[SSCChart]

SSC implementation of BaseCharts.

List elements are SSCChart instances.

class simfile.ssc.SSCSimfile(*, file: Optional[Union[TextIO, Iterator[str]]] = None, string: Optional[str] = None, strict: bool = True)

Bases: simfile.base.BaseSimfile

SSC implementation of BaseSimfile.

Adds the following known properties:

  • SSC version: version

  • Metadata: origin, labels, musiclength, lastsecondhint

  • File paths: previewvid, jacket, cdimage, discimage, preview

  • Gameplay events: combos, speeds, scrolls, fakes

  • Timing data: warps

version
origin
previewvid
jacket
cdimage
discimage
preview
musiclength
lastsecondhint
warps
labels
combos
speeds
scrolls
fakes
classmethod blank(cls: Type[SSCSimfile]) → SSCSimfile

Generate a blank, valid simfile populated with standard keys.

This should approximately match the simfile produced by the StepMania editor in a directory with no .sm or .ssc files.

property charts(self) → SSCCharts

List of charts associated with this simfile.