.osu (формат файлу)

.osu - це придатний до читання людиною формат файлу, що зберігає інформацію про бітмапу.

Структура

На першому рядку зазначена версія формату файлу. Наприклад, osu file format v14 є останньою версією.

Наступний вміст розділений на розділи, позначені назвами в квадратних дужках.

Загальний

Редактор

Ці опції застосовуються лише при відкритті бітмапи в редакторі. Вони не впливають на ігровий процес.

Метадата

Difficulty

Події

Синтаксис події: eventType,startTime,eventParams

• eventType (String чи Integer): Тип події. На деякі події можна посилатися як за назвою, так і за числом.
• startTime (Integer): Час початку події в мілісекундах з початку аудіо бітмапи. Для подій, що не використовують час початку, 0 є значенням за замовчуванням.
• eventParams (Розділений комами список): Додаткові параметри, специфічні для кожного типу події.

Фони

Синтаксис фону: 0,0,filename,xOffset,yOffset

• filename (String): Локація зображення фону відносно папки з картою. Назва файлу, зазвичай, береться в подвійні лапки, але це не є обов'язковим.
• xOffset (Integer) та yOffset (Integer): Зсув у osu!-пікселях від центру екрану. Для прикладу, зсув 50,100 показуватиме фон на 50 osu!-пікселів правіше і 100 osu!-пікселів нижче від центру екрану. Якщо зсув рівний (0,0), його можна не записувати.

Відео

Синтаксис відео: Video,startTime,filename,xOffset,yOffset

Video можна замінити на 1.

• filename (String), xOffset (Integer), та yOffset (Integer) працюють так само, як і для фонів.

Перерви

Синтаксис перерви: 2,startTime,endTime

2 можна замінити на Break.

• endTime (Integer): Час кінця перерви в мілісекундах з початку аудіо бітмапи.

Сторіборди

За інформацією про синтаксис сторіборду дивіться Написання сторіборду.

Сторіборди опціонально можуть бути визначені в окремому файлі з розширенням .osb. Зовнішні сторіборди є спільними для всіх складностей бітмапи.

Кожна карта може зберігати власний сторіборд, унікальний для складності, який може бути сам по собі або об'єднуватись із зовнішнім.

Точки таймінгу

Кожна таймінгова точка впливає на визначену частину карти, яка, зазвичай, називається "таймінговою секцією". Формат файлу .osu вимагає, щоб вони були відсортовані в хронологічному порядку.

Синтаксис точок таймінгу: time,beatLength,meter,sampleSet,sampleIndex,volume,uninherited,effects

• time (Integer): Час початку таймінгової секції в мілісекундах з початку аудіо бітмапи. Кінцем таймінгової секції є час наступної точки таймінгу (якщо ця точка є останньою, він відсутній).
• beatLength (Decimal): Ця властивість може означати:

  • Для неуспадкованих таймінгових точок - тривалість удару в мілісекундах.
  • Для успадкованих таймінгових точок - від’ємний зворотний множник швидкості слайдера у відсотках. Наприклад, -50 пришвидшить всі слайдери цієї таймінгової секції в два рази відносно SliderMultiplier.
• meter (Integer): Кількість ударів у такті. Успадковані точки таймінгу ігнорують цю властивість.
• sampleSet (Integer): Стандартний набір семплів для об’єктів (0 = за замовчуванням, 1 = звичайний, 2 = soft, 3 = drum).
• sampleIndex (Integer): Користувацький індекс семплу для об’єктів. 0 позначає хітсаунди osu! за замовчуванням.
• volume (Integer): Гучність для об'єктів у відсотках.
• uninherited (0 or 1): Чи є таймінгова точка неуспадкованою.
• effects (Integer): Бітові позначення, що дають точкам таймінгу додаткові ефекти. Дивіться розділ про ефекти.

Ефекти

Точки таймінгу мають два додаткових ефекта, які можна перемикати, використовуючи біти 0 і 3 (від менш до більш значного) у числі effects:

• 0: Чи активний час кіаю
• 3: Чи пропущений перший барлайн в osu!taiko і osu!mania

Решта бітів не використовуються.

Приклади

10000,333.33,4,0,0,100,1,1
12000,-25,4,3,0,100,0,1

Перша таймінгова точка на 10 секундах є неуспадкованою та виставляє:

• BPM на 180 (1 / 333.33 * 1000 * 60)
• Тактовий розмір на 4/4
• Набір семплів за замовчуванням
• Індекс семплу на хітсаунди osu! за замовчуванням
• Гучність на 100%
• Час кіаю

Друга таймінгова точка на 12 секундах є успадкованою, змінюючи швидкість слайдера на 4x, а набір семплів на drum.

Кольори

Всі опції в цьому розділі представляють кольори. Вони мають вигляд розділених комою трійок цілих чисел від 0 до 255, представляючих червоний, зелений та синій складники кольорів.

Об'єкти

Синтаксис об'єкту: x,y,time,type,hitSound,objectParams,hitSample

• x (Integer) та y (Integer): Позиція об'єкту в osu!-пікселях.
• time (Integer): Час, коли по об'єкту треба попасти, в мілісекундах з початку аудіо бітмапи.
• type (Integer): Бітові позначення, що вказують на тип об'єкта. Дивіться розділ про типи.
• hitSound (Integer): Бітові позначення, що вказують на застосовані до об'єкта хітсаунди. Дивіться розділ про хітсаунди.
• objectParams (Список, розділений комою): Додаткові параметри, унікальні для кожного типу об'єкту.
• hitSample (Список, розділений двокрапкою): Інформація про те, які семпли програються при попаданні по об'єкту. Вона сильно пов'язана з hitSound; дивіться розділ про хітсаунди. Якщо вона не написана, 0:0:0:0: буде значенням за замовчуванням.

Тип

Параметр типу об'єкту - це 8-бітне ціле число, де кожен біт має спеціальне значення.

Хітсаунди

Бітові позначення hitSound визначають, які звуки програватимуться при попаданні по об'єкту:

Якщо жодного біта не вказано, за замовчуванням використовуватиметься стандартний звук.

В кожному режимі, крім osu!mania, властивість скіна LayeredHitSounds примусово включає звичайний звук, незалежно від того, встановлений біт 0 чи ні. За замовчуванням вона активована.

Користувацькі семпли

Використання hitSample може ще більше кастомізувати звуки, що програються. За замовчуванням його значення 0:0:0:0:, якщо не написано іншого.

Синтаксис семплу: normalSet:additionSet:index:volume:filename

• normalSet (Integer): Набір семплів зі звичайним звуком.
• additionSet (Integer): Набір семплів зі звуками whistle, finish та clap.
• index (Integer): Індекс семплу. Якщо 0, замість нього буде використано індекс семплу таймінгової точки.
• volume (Integer): Гучність семплу від 1 до 100. Якщо 0, замість цього буде використана гучність таймінгової точки.
• filename (String): Користувацька назва файлу з додатковим звуком.

normalSet і additionSet можуть мати будь-яке з наступних значень:

• 0: Без користувацького набору семплів

  • Для звичайних звуків набір визначається набором семплів точки таймінгу.
  • Для додаткових набір визначається набором семплів звичайного звуку.
• 1: Звичайний набір
• 2: Набір Soft
• 3: Набір Drum

Всі ці опції (крім гучності) використовуються для визначення, який файл звуку програватиметься для даного хітсаунду. Назва файлу має вигляд <sampleSet>-hit<hitSound><index>.wav, де:

• sampleSet є normal, soft, чи drum, що визначає або normalSet, або additionSet, в залежності від того, який хітсаунд грає
• hitSound є normal, whistle, finish, або clap
• index - це той же index, що й вище, за винятком того, що він не пишеться, якщо значенням є 0 чи 1

Файл звуку завантажується з першої із наступних папок, яка містить файл з відповідною назвою:

• Папка бітмапи, якщо index не 0
• Папка скіну, при цьому index прибирається
• Ресурси osu! за замовчуванням, при цьому index прибирається

При наданні filename додаткові звуки не програватимуться, замість них гратиме цей файл у папці бітмапи.

Круги

Круги не мають додаткових параметрів objectParams.

Слайдери

Синтаксис слайдеру: x,y,time,type,hitSound,curveType|curvePoints,slides,length,edgeSounds,edgeSets,hitSample

• curveType (Літера): Тип кривої, що використовується для побудови цього слайдера (B = безьє, C = доцентровий кетмелл-ром, L = лінійна, P = ідеальне коло)
• curvePoints (Список строк, розділений вертикальною лінією): Опорні точки, що використовуються для побудови слайдера. Кожна точка має формат x:y.
• slides (Integer): Скільки разів гравець повинен слідувати за кривою слайдера туди й назад, перш ніж слайдер буде закінчено. Це також можна інтерпретувати як кількість повторів плюс один.
• length (Decimal): Візуальна довжина слайдера в osu!-пікселях.
• edgeSounds (Список цілих чисел, розділений вертикальною лінією): Хітсаунди, що відтворюються при попаданні по краю кривої слайдера. Перший звук - той, що програється під час першого натискання на слайдер, а останній – звук, який відтворюється при закінченні слайдера.
• edgeSets (Список строк, розділений вертикальною лінією): Набори семплів, що використовуються для edgeSounds. Кожен набір має формат normalSet:additionSet з таким самим значенням, як і в розділі про хітсаунди.

Криві для слайдера

При побудові кривих для слайдера x та y використовуються для першої точки, а curvePoints постачає всі інші.

Є чотири типи кривих для слайдера в osu!:

• Безьє (B): Криві Безьє довільного ступеня можуть бути зроблені. Декілька кривих Безьє можуть бути об'єднані в один слайдер за допомогою повторення їх точок перетину.
• Доцентровий кетмелл-ром (C): Криві Кетмелла є інтерполяційною альтернативою кривим Безьє. Сьогодні вони рідко використовуються через відсутність візуальної привабливості.
• Лінійна (L): Ці криві утворюють прямий шлях між усіма своїми точками.
• Ідеальне коло (P): Криві ідеального кола обмежені трьома точками (включно з положенням об’єкта), які визначають межу кола. Використання більше трьох точок призведе до зміни типу кривої на Безьє.

Якщо length слайдеру є довшою за визначену криву, слайдер буде продовжуватись, поки не досягне цільової довжини:

• Для Безьє, Кетмелла й лінійної кривих продовження буде прямою лінією з кінця кривої.
• Для кривих ідеального кола це продовжуватиме дугу кола.

Зауважте: length слайдера може бути використана для визначення часу, необхідного для закінчення слайдера. length / (SliderMultiplier * 100 * SV) * beatLength вказує, скільки мілісекунд потрібно для завершення одного слайда слайдера (де SV - це коефіцієнт швидкості слайдера, який задається діючою успадкованою точкою таймінгу, або 1, якщо такої немає).

Хітсаунди слайдерів

Окрім крайових хітсаундів, слайдери також мають постійний хітсаунд весь час, поки гравець в зоні слідуючого кола слайдера. Звуковий файл зациклюється весь той час, поки він активний.

Цей хітсаунд використовує властивості hitSound і hitSample об'єкта, але підтримуються тільки звичайний та whistle звуки. Його назва файлу має вигляд <sampleSet>-slider<hitSound><index>.wav, де hitSound - це або slide для звичайного звуку, або whistle для whistle.

Спінери

Синтаксис спінера: x,y,time,type,hitSound,endTime,hitSample

• endTime (Integer): Час закінчення спінера в мілісекундах з початку аудіо бітмапи.
• x та y не впливають на спінери. Вони за замовчуванням вказують на центр ігрового поля, тобто рівні 256,192.

Довгі ноти (лише в osu!mania)

Синтаксис довгої ноти: x,y,time,type,hitSound,endTime:hitSample

• endTime (Integer): Час закінчення довгої ноти в мілісекундах з початку аудіо бітмапи.
• x визначає індекс колонки, в якій буде довга нота. Вираховується це за формулою floor(x * columnCount / 512) і приймає значення між 0 та columnCount - 1.
• y не впливає на довгі ноти. За замовчуванням вказує не центр ігрового поля, тобто рівний 192.

Приклади

256,192,11000,21,2
256,192,11200,8,12,12000,3:0:0:80:
100,100,12600,6,1,B|200:200|250:200|250:200|300:150,2,310.123,2|1|2,0:0|0:0|0:2,0:0:0:0:

Перший об'єкт - це круг:

• В центрі екрану
• На 11 секундах
• Починає нове комбо і пропускає один додатковий колір комбо
• Має хітсаунд whistle

Другий об'єкт - це спінер:

• На 11.2 секундах
• Закінчується на 12 секундах
• Має хітсаунди finish і clap, що грають з гучністю 80%
• Має звичайний хітсаунд, що грає з набором drum з гучністю 80%

Третій об'єкт - це слайдер:

• В позиції (100,100)
• На 12.6 секундах
• Починає нове комбо
• Зі змішаною кривою Безьє, де першими контрольними точками кривої є (100,100), (200,200) та (250,200), і другими контрольними точками кривої є (250,200) та (300,150). Контрольні точки, що повторюються, позначають червону опорну точку.
• Повторюється один раз
• Має довжину в 310.123 osu!-пікселів
• Має хітсаунд whistle на початку і хітсаунд whistle з набором soft у кінці

osu!taiko

Об'єкти osu!taiko використовують лише time для визначення, як вони будуть розміщені на ігровому полі, тому x та y ігноруються. Так само і для кривих слайдерів єдиною значущою частиною є length; curveType і curvePoints актуальні лише при відкритті карти в редакторі. Кольори комбо і нові комбо ігноруються, а хітсаунди, що використовуються, є специфічними для цього режиму.

• Круги з хітсаундами whistle або clap стають катами, а всі інші круги - донами. Додавання хітсаунду finish перетворює їх на великі версії.
• Слайдери стають драмролами.
• Спінери стають денден нотами.

osu!catch

Поле гри osu!catch використовує тільки вісь x, отже, y не грає ролі. Криві слайдера можуть використовувати вертикальний простір для досягнення горизонтального прискорення, коли вони сплющені до одновимірного ігрового поля.

• Круги стають фруктами.
• Слайдери стають потоками соку з фруктами на кожному краю.
• Спінери стають дощами з бананів

osu!mania

Так само, як і в osu!catch, об'єкти в osu!mania не використовують y. x використовується для визначення колонки; дивіться розділ про довгі ноти.

• Круги стають звичайними нотами.
• Слайдери і спінери в osu!mania не використовуються.