СубтитрыAPI

API субтитров

Центральный API для получения локализованных субтитров.

Обратная связь.

Если у вас есть отзывы, пожалуйста, опубликуйте их на странице Github Issues!

Использование.

Если вы создаете мод и хотите добавить субтитры для пользовательских звуков, это очень просто! Просто добавьте .dll-файл мода в ссылку на ваш проект и добавьте следующий код:

Static SubtitlesAPI.SubtitlesAPI;

try.

{

 Localisation.AddTranslation(«CustomSound», «Custom Subtitles»);

}

Catch.

{

 Debug.Log(«Режим SubtitlesAPI не найден»); }

}

Нет необходимости даже просить игрока использовать этот режим!

Методы.

SubtitlesAPI.Localization.AddTranslation(string soundFileName, string subtitleText);

SubtitlesAPI.Localisation.AddTranslation(Dictionary<string, string>);

Dictionary<string, string>- словарь, содержащий Key: soundFileName, Value: subtitleText.

SubtitlesAPI.Localisation.AddDialogueTranslation(string sound, List<(float, string)> subtitles);

SubtitlesAPI.Localisation.AddDialogueTranslation(Dictionary<string, List<(float, string)>> translationsToAdd);

где Dictionary<string, List<(float, string)>> это словарь с Key: soundFileName и Value: subtitles.

Этот метод возвращает булево значение словаря или список булевых значений.

Результат будет равен true, если мод смог добавить субтитры, или false, если нет. Другие моды могут иметь такое же имя аудиофайла.

Вклад.

Хотите добавить или изменить субтитры? Хотите создать новые локали для других языков? Сделайте это! Создайте форк этого репозитория, внесите туда свои дополнения или изменения и отправьте запрос на исправление.

Дополнительные субтитры

Откройте локаль, которую вы хотите изменить (например, EnglishSubtitleLocalisation.cs), и добавьте ее в словарь!

SubtitleAPI.localisation. Перевод

Словарь будет использовать следующий формат для новых записей:

{ 'SoundFileName' , 'Subtitle to Add' }

SubtitlesAPI.Localisation.DialogueTranslations

Словарь использует следующий формат для новых записей:

{

 F0DaysLeftAlert»,

 new()

 {

  (0, «[Звучит джингл компании]»),

  (4.969f, «Немедленно явиться в офис компании»),

  (7.189f, «продажа металлолома и т.д.»),

  (9.758f, «У вас есть 0 дней, чтобы достичь своей квоты прибыли»),

  (13.085f), «Вы можете использовать терминал для маршрутизации»,

  (14.874f, «Мы отправляемся в здание компании на автопилоте»), (14.874f, «Мы отправляемся в здание компании на автопилоте») }

 }

}, }

{ }, }, }, }, }, }, }, }, }, }, }, }, }, }, }, }, Новая локаль.

Чтобы создать новую локаль, просто добавьте новый файл в папку Locale, измените Locale на локаль, которую вы хотите добавить, используя интерфейс ISubtitleLocalisation, и добавьте перевод в словарь!

Пример локали

public class EnglishSubtitleLocalization : ISubtitleLocalisation

{

 public string Locale => «en»;

 public Dictionary<string, string> Translations => new(StringComparer.OrdinalIgnoreCase) {

  { «AirHorn1», «Игрок на воздушном рожке» }

 }

 public Dictionary<string, List<(float, string)>> DialogueTranslations => new(StringComparer.OrdinalIgnoreCase)

  {

   {

    «F0DaysLeftAlert»,

    new()

    {

     (0, «[играет джингл компании]»),

     (4.969f, «Немедленно явиться на территорию компании»),

     (7.189f, «продажа металлолома и т.д.»),

     (9.758f, «У вас есть 0 дней, чтобы достичь своей квоты прибыли»),

     (13.085f), «Вы можете использовать терминал для маршрутизации»,

     (14.874f, «Мы отправляемся в здание компании на автопилоте»), (14.874f, «Мы отправляемся в здание компании на автопилоте») }

    }

   },

  };

}