https://github.com/Kalfadda/Scythe-Cards-Subtitle-System

A simple and barebones subtitle system that takes advantage of Unity's Scriptable Object Workflow to allow game developers to add subtitles quickly, easily and efficiently.
https://github.com/Kalfadda/Scythe-Cards-Subtitle-System

accessibility closed-captioning subtitles unity3d

Last synced: 2 months ago
JSON representation

A simple and barebones subtitle system that takes advantage of Unity's Scriptable Object Workflow to allow game developers to add subtitles quickly, easily and efficiently.

• Host: GitHub
• URL: https://github.com/Kalfadda/Scythe-Cards-Subtitle-System
• Owner: Kalfadda
• License: mit
• Created: 2022-06-27T06:38:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-01T19:25:42.000Z (almost 2 years ago)
• Last Synced: 2024-04-22T08:33:28.699Z (6 months ago)
• Topics: accessibility, closed-captioning, subtitles, unity3d
• Language: C#
• Homepage:
• Size: 122 KB
• Stars: 15
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 

![image](https://user-images.githubusercontent.com/38150569/175878182-e126dc06-4562-4494-b54b-7d3e58c0f203.png)

[![CodeFactor](https://www.codefactor.io/repository/github/kalfadda/scythe-cards-subtitle-system/badge/main)](https://www.codefactor.io/repository/github/kalfadda/scythe-cards-subtitle-system/overview/main)


Created in Unity 2021.3.4f1


Compatible with Unity 5+

Scythe Cards is a *simple* and *barebones* subtitle system that takes advantage of Unity's Scriptable Object Workflow to allow game developers of all skill levels to add accessibility options to their games quickly, easily and efficiently.

**Requirements:**

- TextMesh Pro

**Instructions:**

- Extract the Unity Package into your game

- Open the 'Example Scene' (Scythe Cards>Scenes>Example Scene)

- Press Play

**Breakdown:**


'Prefab Manager' must exist in any scene requiring subtitles (drag it in from the prefabs folder).


In any script of your own you can now define a reference to SubtitleCard:

```cs

public SubtitleCard _shopKeeperDialogue;

```

and from that very same script (or others) simply call

```cs

SubtitleManager.instance.CueSubtitle(_shopKeeperDialogue);

```

I.E.

```cs

using Scythe.Accessibility;

public SubtitleCard _shopKeeperDialogue;

void Start()

{

    SubtitleManager.instance.CueSubtitle(_shopKeeperDialogue);

}

```

Subtitle Cards reference the ***Subtitle Card Data*** Scriptable Objects. You can easily create those

by right clicking in your project folder (Right Click > Create > Subtitle Card Data). Just add your dialogue and timing.

For a full explanation please see the barebones 'Example Scene' and review the code and tooltips to understand better.

Scythe Cards was kept as minimal as possible to allow flexibility and extension however you see fit. Some examples

of different applications could be:

- Creating an array of SubtitleCards[], to control an entire conversation in an easy sequence.

- Queueing audioclips in addition to the subtitle card execution for an all-in-one dialogue system.

- Overloading with languange varations and using a switch case to determine which array to use.

- Use multiple text objects to control many worldspace text elements for localization.

MIT License

Copyright (c) 2022 Kaleb Alfadda