simfile
What are simfiles?
Reading & writing simfiles
Known properties
Timing data
Timing & note data
Learn by example
Changelog
Migrating from simfile 1.0 to 2.0
API Reference
simfile
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
ADD_ALL (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
ADD_CHART_MEASURES (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
ADD_CHART_PREAMBLE (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
ADD_LIBRARY_VERSION_PREAMBLE (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
append() (simfile.sm.SMCharts method)
(simfile.ssc.SSCCharts method)
artist (simfile.base.BaseSimfile attribute)
artisttranslit (simfile.base.BaseSimfile attribute)
Assets (class in simfile.assets)
assets() (simfile.dir.SimfileDirectory method)
AttachedChart (in module simfile.types)
AttachedSMChart (class in simfile.sm)
AttachedSSCChart (class in simfile.ssc)
ATTACK (simfile.notes.NoteType attribute)
attacks (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
B
background (simfile.assets.Assets property)
(simfile.base.BaseSimfile attribute)
banner (simfile.assets.Assets property)
(simfile.base.BaseSimfile attribute)
banner() (simfile.dir.SimfilePack method)
BaseChart (class in simfile.base)
BaseCharts (class in simfile.base)
BaseSimfile (class in simfile.base)
Beat (class in simfile.timing)
beat (simfile.notes.group.NoteWithTail attribute)
(simfile.notes.Note attribute)
(simfile.timing.BeatValue attribute)
beat_at() (simfile.timing.engine.TimingEngine method)
BeatValue (class in simfile.timing)
BeatValues (class in simfile.timing)
behaviors() (simfile.tidy.behaviors.Preset method)
(simfile.tidy.Preset method)
bgchanges (simfile.base.BaseSimfile attribute)
blank() (simfile.base.BaseChart class method)
(simfile.base.BaseSimfile class method)
(simfile.sm.SMChart class method)
(simfile.sm.SMSimfile class method)
(simfile.ssc.SSCChart class method)
(simfile.ssc.SSCSimfile class method)
BPM (simfile.timing.engine.EventTag attribute)
bpm_at() (simfile.timing.engine.TimingEngine method)
bpms (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
(simfile.timing.TimingData attribute)
C
CancelMutation
cdimage (simfile.assets.Assets property)
(simfile.ssc.SSCSimfile attribute)
cdtitle (simfile.assets.Assets property)
(simfile.base.BaseSimfile attribute)
ChangeComments (class in simfile.tidy)
(class in simfile.tidy.behaviors)
Chart (in module simfile.types)
chartname (simfile.ssc.SSCChart attribute)
Charts (in module simfile.types)
charts (simfile.base.BaseSimfile property)
(simfile.sm.SMSimfile property)
(simfile.ssc.SSCSimfile property)
chartstyle (simfile.ssc.SSCChart attribute)
column (simfile.notes.group.NoteWithTail attribute)
(simfile.notes.Note attribute)
columns (simfile.notes.NoteData property)
combos (simfile.ssc.SSCChart attribute)
(simfile.ssc.SSCSimfile attribute)
COPY_ANYWAY (simfile.convert.InvalidPropertyBehavior attribute)
count_fakes() (in module simfile.notes.counter)
count_grouped_notes() (in module simfile.notes.count)
count_hands() (in module simfile.notes.count)
(in module simfile.notes.counter)
count_holds() (in module simfile.notes.count)
(in module simfile.notes.counter)
count_jumps() (in module simfile.notes.count)
(in module simfile.notes.counter)
count_mines() (in module simfile.notes.count)
(in module simfile.notes.counter)
count_rolls() (in module simfile.notes.count)
(in module simfile.notes.counter)
count_steps() (in module simfile.notes.count)
(in module simfile.notes.counter)
count_taps() (in module simfile.notes.counter)
CreateMissingProperties (class in simfile.tidy)
(class in simfile.tidy.behaviors)
credit (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
CRLF (simfile.tidy.behaviors.LineEndings attribute)
(simfile.tidy.LineEndings attribute)
D
DELAY (simfile.timing.engine.EventTag attribute)
DELAY_END (simfile.timing.engine.EventTag attribute)
delays (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
(simfile.timing.TimingData attribute)
description (simfile.base.BaseChart attribute)
DestructivelyRemoveProperties (class in simfile.tidy)
(class in simfile.tidy.behaviors)
detach() (simfile.sm.AttachedSMChart method)
(simfile.ssc.AttachedSSCChart method)
difficulty (simfile.base.BaseChart attribute)
disc (simfile.assets.Assets property)
discimage (simfile.ssc.SSCSimfile attribute)
DisplayBPM (in module simfile.timing.displaybpm)
displaybpm (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
displaybpm() (in module simfile.timing.displaybpm)
DROP_ORPHAN (simfile.notes.group.OrphanedNotes attribute)
DuplicateSimfileError
E
ERROR (simfile.convert.InvalidPropertyBehavior attribute)
ERROR_UNLESS_DEFAULT (simfile.convert.InvalidPropertyBehavior attribute)
EventTag (class in simfile.timing.engine)
extend() (simfile.sm.SMCharts method)
(simfile.ssc.SSCCharts method)
extradata (simfile.sm.SMChart attribute)
F
FAKE (simfile.notes.NoteType attribute)
(simfile.timing.engine.EventTag attribute)
FAKE_END (simfile.timing.engine.EventTag attribute)
fakes (simfile.ssc.SSCChart attribute)
(simfile.ssc.SSCSimfile attribute)
(simfile.timing.TimingData attribute)
fgchanges (simfile.base.BaseSimfile attribute)
FILE_PATH (simfile.convert.PropertyType attribute)
filesystem (simfile.assets.Assets attribute)
(simfile.dir.SimfileDirectory attribute)
(simfile.dir.SimfilePack attribute)
from_msd() (simfile.sm.SMChart class method)
from_msd_parameter() (simfile.sm.SMChart class method)
from_notes() (simfile.notes.NoteData class method)
from_str() (simfile.sm.SMChart class method)
(simfile.ssc.SSCChart class method)
(simfile.timing.Beat class method)
(simfile.timing.BeatValues class method)
G
GAMEPLAY_EVENT (simfile.convert.PropertyType attribute)
genre (simfile.base.BaseSimfile attribute)
group_notes() (in module simfile.notes.group)
GroupedNotes (in module simfile.notes.group)
H
HEURISTIC (simfile.tidy.behaviors.LineEndings attribute)
(simfile.tidy.LineEndings attribute)
hittable (simfile.notes.timed.TimedNote attribute)
hittable() (simfile.timing.engine.TimingEngine method)
HOLD_HEAD (simfile.notes.NoteType attribute)
I
IGNORE (simfile.convert.InvalidPropertyBehavior attribute)
instrumenttrack (simfile.base.BaseSimfile attribute)
InvalidPropertyBehavior (class in simfile.convert)
InvalidPropertyException
J
jacket (simfile.assets.Assets property)
(simfile.ssc.SSCSimfile attribute)
JOIN_ALL (simfile.notes.group.SameBeatNotes attribute)
JOIN_BY_NOTE_TYPE (simfile.notes.group.SameBeatNotes attribute)
K
KEEP_ORPHAN (simfile.notes.group.OrphanedNotes attribute)
KEEP_SEPARATE (simfile.notes.group.SameBeatNotes attribute)
KEYSOUND (simfile.notes.NoteType attribute)
keysound_index (simfile.notes.group.NoteWithTail attribute)
(simfile.notes.Note attribute)
keysounds (simfile.base.BaseSimfile attribute)
L
labels (simfile.ssc.SSCChart attribute)
(simfile.ssc.SSCSimfile attribute)
lastsecondhint (simfile.ssc.SSCSimfile attribute)
LF (simfile.tidy.behaviors.LineEndings attribute)
(simfile.tidy.LineEndings attribute)
LIFT (simfile.notes.NoteType attribute)
LineEndings (class in simfile.tidy)
(class in simfile.tidy.behaviors)
load() (in module simfile)
loads() (in module simfile)
lyricspath (simfile.base.BaseSimfile attribute)
M
max (simfile.timing.displaybpm.RandomDisplayBPM property)
(simfile.timing.displaybpm.RangeDisplayBPM attribute)
(simfile.timing.displaybpm.StaticDisplayBPM property)
METADATA (simfile.convert.PropertyType attribute)
meter (simfile.base.BaseChart attribute)
min (simfile.timing.displaybpm.RandomDisplayBPM property)
(simfile.timing.displaybpm.RangeDisplayBPM attribute)
(simfile.timing.displaybpm.StaticDisplayBPM property)
MINE (simfile.notes.NoteType attribute)
module
simfile
simfile.assets
simfile.base
simfile.convert
simfile.dir
simfile.notes
simfile.notes.count
simfile.notes.counter
simfile.notes.group
simfile.notes.timed
simfile.sm
simfile.ssc
simfile.tidy
simfile.tidy.behaviors
simfile.timing
simfile.timing.displaybpm
simfile.timing.engine
simfile.types
MULTI_VALUE_PROPERTIES (simfile.base.BaseSimfile attribute)
music (simfile.assets.Assets property)
(simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
mutate() (in module simfile)
N
name (simfile.dir.SimfilePack property)
NO_OP (simfile.tidy.behaviors.Preset attribute)
(simfile.tidy.Preset attribute)
Note (class in simfile.notes)
note (simfile.notes.timed.TimedNote attribute)
note_type (simfile.notes.group.NoteWithTail attribute)
(simfile.notes.Note attribute)
NoteData (class in simfile.notes)
notes (simfile.base.BaseChart attribute)
(simfile.ssc.SSCChart attribute)
NoteType (class in simfile.notes)
NoteWithTail (class in simfile.notes.group)
O
offset (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
(simfile.timing.TimingData attribute)
open() (in module simfile)
(simfile.dir.SimfileDirectory method)
open_with_detected_encoding() (in module simfile)
opendir() (in module simfile)
openpack() (in module simfile)
origin (simfile.ssc.SSCSimfile attribute)
OrphanedNoteException
OrphanedNotes (class in simfile.notes.group)
P
pack_dir (simfile.dir.SimfilePack attribute)
player (simfile.notes.group.NoteWithTail attribute)
(simfile.notes.Note attribute)
pop() (simfile.sm.SMChart method)
popitem() (simfile.sm.SMChart method)
Preset (class in simfile.tidy)
(class in simfile.tidy.behaviors)
preview (simfile.ssc.SSCSimfile attribute)
previewvid (simfile.ssc.SSCSimfile attribute)
PropertyType (class in simfile.convert)
R
radarvalues (simfile.base.BaseChart attribute)
RAISE_EXCEPTION (simfile.notes.group.OrphanedNotes attribute)
RandomDisplayBPM (class in simfile.timing.displaybpm)
range (simfile.timing.displaybpm.RandomDisplayBPM property)
(simfile.timing.displaybpm.RangeDisplayBPM property)
(simfile.timing.displaybpm.StaticDisplayBPM property)
RangeDisplayBPM (class in simfile.timing.displaybpm)
RECOMMENDED (simfile.tidy.behaviors.Preset attribute)
(simfile.tidy.Preset attribute)
REMOVE_ALL (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
REMOVE_CHART_INNER (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
REMOVE_CHART_PREAMBLE (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
REMOVE_OTHER (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
REMOVE_PREAMBLE (simfile.tidy.behaviors.ChangeComments attribute)
(simfile.tidy.ChangeComments attribute)
ROLL_HEAD (simfile.notes.NoteType attribute)
round_to_tick() (simfile.timing.Beat method)
run() (simfile.tidy.behaviors.ChangeComments method)
(simfile.tidy.behaviors.CreateMissingProperties method)
(simfile.tidy.behaviors.DestructivelyRemoveProperties method)
(simfile.tidy.behaviors.LineEndings method)
(simfile.tidy.behaviors.SortProperties method)
(simfile.tidy.behaviors.Whitespace method)
(simfile.tidy.ChangeComments method)
(simfile.tidy.CreateMissingProperties method)
(simfile.tidy.DestructivelyRemoveProperties method)
(simfile.tidy.LineEndings method)
(simfile.tidy.SortProperties method)
(simfile.tidy.Whitespace method)
S
SameBeatNotes (class in simfile.notes.group)
samplelength (simfile.base.BaseSimfile attribute)
samplestart (simfile.base.BaseSimfile attribute)
scrolls (simfile.ssc.SSCChart attribute)
(simfile.ssc.SSCSimfile attribute)
selectable (simfile.base.BaseSimfile attribute)
serialize() (simfile.base.BaseCharts method)
(simfile.base.BaseSimfile method)
(simfile.sm.SMChart method)
(simfile.ssc.SSCChart method)
simfile
module
Simfile (in module simfile.types)
simfile.assets
module
simfile.base
module
simfile.convert
module
simfile.dir
module
simfile.notes
module
simfile.notes.count
module
simfile.notes.counter
module
simfile.notes.group
module
simfile.notes.timed
module
simfile.sm
module
simfile.ssc
module
simfile.tidy
module
simfile.tidy.behaviors
module
simfile.timing
module
simfile.timing.displaybpm
module
simfile.timing.engine
module
simfile.types
module
simfile_dir (simfile.assets.Assets attribute)
(simfile.dir.SimfileDirectory attribute)
simfile_dir_paths (simfile.dir.SimfilePack attribute)
simfile_dirs() (simfile.dir.SimfilePack method)
simfile_path (simfile.dir.SimfileDirectory property)
SimfileDirectory (class in simfile.dir)
SimfilePack (class in simfile.dir)
simfiles() (simfile.dir.SimfilePack method)
SM5 (simfile.tidy.behaviors.CreateMissingProperties attribute)
(simfile.tidy.behaviors.DestructivelyRemoveProperties attribute)
(simfile.tidy.behaviors.Preset attribute)
(simfile.tidy.behaviors.SortProperties attribute)
(simfile.tidy.behaviors.Whitespace attribute)
(simfile.tidy.CreateMissingProperties attribute)
(simfile.tidy.DestructivelyRemoveProperties attribute)
(simfile.tidy.Preset attribute)
(simfile.tidy.SortProperties attribute)
(simfile.tidy.Whitespace attribute)
SM5_DESTRUCTIVE (simfile.tidy.behaviors.Preset attribute)
(simfile.tidy.Preset attribute)
SM_CHART_PROPERTIES (in module simfile.sm)
sm_path (simfile.dir.SimfileDirectory attribute)
SM_SIMFILE_PROPERTIES (in module simfile.sm)
sm_to_ssc() (in module simfile.convert)
SMChart (class in simfile.sm)
SMCharts (class in simfile.sm)
SMSimfile (class in simfile.sm)
SongTime (class in simfile.timing.engine)
SortProperties (class in simfile.tidy)
(class in simfile.tidy.behaviors)
speeds (simfile.ssc.SSCChart attribute)
(simfile.ssc.SSCSimfile attribute)
ssc_path (simfile.dir.SimfileDirectory attribute)
ssc_to_sm() (in module simfile.convert)
SSC_VERSION (simfile.convert.PropertyType attribute)
SSCChart (class in simfile.ssc)
SSCCharts (class in simfile.ssc)
SSCSimfile (class in simfile.ssc)
StaticDisplayBPM (class in simfile.timing.displaybpm)
stepstype (simfile.base.BaseChart attribute)
STOP (simfile.timing.engine.EventTag attribute)
STOP_END (simfile.timing.engine.EventTag attribute)
stops (simfile.base.BaseSimfile attribute)
(simfile.sm.SMSimfile attribute)
(simfile.ssc.SSCChart attribute)
(simfile.timing.TimingData attribute)
subtitle (simfile.base.BaseSimfile attribute)
subtitletranslit (simfile.base.BaseSimfile attribute)
T
TAIL (simfile.notes.NoteType attribute)
tail_beat (simfile.notes.group.NoteWithTail attribute)
TAP (simfile.notes.NoteType attribute)
tick() (simfile.timing.Beat class method)
tickcounts (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
tidy() (in module simfile.tidy)
time (simfile.notes.timed.TimedNote attribute)
time_at() (simfile.timing.engine.TimingEngine method)
time_chart() (in module simfile.notes.timed)
time_notes() (in module simfile.notes.timed)
TimedNote (class in simfile.notes.timed)
timesignatures (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
TIMING_DATA (simfile.convert.PropertyType attribute)
timing_data (simfile.timing.engine.TimingEngine attribute)
TimingData (class in simfile.timing)
TimingEngine (class in simfile.timing.engine)
title (simfile.base.BaseSimfile attribute)
titletranslit (simfile.base.BaseSimfile attribute)
U
ungroup_notes() (in module simfile.notes.group)
update() (simfile.sm.SMChart method)
V
value (simfile.timing.BeatValue attribute)
(simfile.timing.displaybpm.RandomDisplayBPM property)
(simfile.timing.displaybpm.RangeDisplayBPM property)
(simfile.timing.displaybpm.StaticDisplayBPM attribute)
values() (simfile.sm.SMChart method)
version (simfile.ssc.SSCSimfile attribute)
W
WARP (simfile.timing.engine.EventTag attribute)
WARP_END (simfile.timing.engine.EventTag attribute)
warps (simfile.ssc.SSCChart attribute)
(simfile.ssc.SSCSimfile attribute)
(simfile.timing.TimingData attribute)
Whitespace (class in simfile.tidy)
(class in simfile.tidy.behaviors)