simfile
main
What are simfiles?
Reading & writing simfiles
Known properties
Timing & note data
Learn by example
Changelog
Migrating from simfile 1.0 to 2.0
API Reference
simfile
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
artist (simfile.base.BaseSimfile attribute)
artisttranslit (simfile.base.BaseSimfile attribute)
Assets (class in simfile.assets)
assets() (simfile.dir.SimfileDirectory method)
ATTACK (simfile.notes.NoteType attribute)
attacks (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
B
background (simfile.base.BaseSimfile attribute)
background() (simfile.assets.Assets property)
banner (simfile.base.BaseSimfile attribute)
banner() (simfile.assets.Assets property)
(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)
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.ssc.SSCSimfile attribute)
cdimage() (simfile.assets.Assets property)
cdtitle (simfile.base.BaseSimfile attribute)
cdtitle() (simfile.assets.Assets property)
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_grouped_notes() (in module simfile.notes.count)
count_hands() (in module simfile.notes.count)
count_holds() (in module simfile.notes.count)
count_jumps() (in module simfile.notes.count)
count_mines() (in module simfile.notes.count)
count_rolls() (in module simfile.notes.count)
count_steps() (in module simfile.notes.count)
credit (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart 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)
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_NOTE (simfile.notes.timed.UnhittableNotes attribute)
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)
extradata (simfile.sm.SMChart attribute)
F
FAKE (simfile.notes.NoteType attribute)
fakes (simfile.ssc.SSCChart attribute)
(simfile.ssc.SSCSimfile attribute)
fgchanges (simfile.base.BaseSimfile attribute)
FILE_PATH (simfile.convert.PropertyType attribute)
from_msd() (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
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.ssc.SSCSimfile attribute)
jacket() (simfile.assets.Assets property)
JOIN_ALL (simfile.notes.group.SameBeatNotes attribute)
JOIN_BY_NOTE_TYPE (simfile.notes.group.SameBeatNotes attribute)
K
KEEP_NOTE (simfile.notes.timed.UnhittableNotes attribute)
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)
LIFT (simfile.notes.NoteType attribute)
load() (in module simfile)
loads() (in module simfile)
lyricspath (simfile.base.BaseSimfile attribute)
M
max (simfile.timing.displaybpm.RangeDisplayBPM attribute)
max() (simfile.timing.displaybpm.RandomDisplayBPM property)
(simfile.timing.displaybpm.StaticDisplayBPM property)
METADATA (simfile.convert.PropertyType attribute)
meter (simfile.base.BaseChart attribute)
min (simfile.timing.displaybpm.RangeDisplayBPM attribute)
min() (simfile.timing.displaybpm.RandomDisplayBPM property)
(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.group
simfile.notes.timed
simfile.sm
simfile.ssc
simfile.timing
simfile.timing.displaybpm
simfile.timing.engine
simfile.types
MULTI_VALUE_PROPERTIES (simfile.base.BaseSimfile attribute)
music (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
music() (simfile.assets.Assets property)
musiclength (simfile.ssc.SSCSimfile attribute)
mutate() (in module simfile)
N
name() (simfile.dir.SimfilePack property)
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
player (simfile.notes.group.NoteWithTail attribute)
(simfile.notes.Note attribute)
pop() (simfile.sm.SMChart method)
popitem() (simfile.sm.SMChart method)
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)
ROLL_HEAD (simfile.notes.NoteType attribute)
round_to_tick() (simfile.timing.Beat 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.group
module
simfile.notes.timed
module
simfile.sm
module
simfile.ssc
module
simfile.timing
module
simfile.timing.displaybpm
module
simfile.timing.engine
module
simfile.types
module
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)
sm_path (simfile.dir.SimfileDirectory attribute)
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)
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)
TAP_TO_FAKE (simfile.notes.timed.UnhittableNotes attribute)
tick() (simfile.timing.Beat class method)
tickcounts (simfile.base.BaseSimfile attribute)
(simfile.ssc.SSCChart attribute)
time (simfile.notes.timed.TimedNote attribute)
time_at() (simfile.timing.engine.TimingEngine method)
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)
UnhittableNotes (class in simfile.notes.timed)
update() (simfile.sm.SMChart method)
V
value (simfile.timing.BeatValue attribute)
(simfile.timing.displaybpm.StaticDisplayBPM attribute)
value() (simfile.timing.displaybpm.RandomDisplayBPM property)
(simfile.timing.displaybpm.RangeDisplayBPM property)
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)
Read the Docs
v: main
Versions
latest
main
dev
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds