Skip to content
/ Ameko Public

Cross-platform editor for Advanced Substation Alpha (ASS) subtitles

Notifications You must be signed in to change notification settings

9vult/Ameko

Repository files navigation

Ameko

Ameko Banner Logo


Ameko is a subtitle editing suite for Advanced Substation Alpha (ASS) subtitles.

Roadmap

Milestone 1 - MVP (Complete)

The goal for Milestone 1 is to have a Minimum Viable Product (MVP). In Ameko's case, the MVP is delivering a feature-rich subtitle editor. Note that Ameko intends to be an editing suite in its final form. Thus, the MVP is missing some pretty major features one might consider invaluable to the subtitle workflow, such as audio, video, graphical tools, etc.

However, as Milestone 1 is serving mostly as a proof-of-concept for the viability of the Ameko-Holo-AssCS pipeline, a fully-featured subtitle editor will play the role of the minimuim product. The full list of MVP features can be found under the MVP milestone issue filter, but the gist is that it should include all major editing features that don't require audio or video as part of the workflow.

Milestone 2 - Video

Video is clearly the second most important feature for a subtitle editor (behind only subtitle editing features). Video loading will be provided via Plugins so Holo/Ameko is not dependent on any one source. The first video provider will be FFMS2. The full specifics of the video milestone are still in the air; it is currently unclear if features like subtitle rendering will be included within or pushed to a different milestone. The current goal and focus of this milestone is to have a working video player.

Future Milestones

As Ameko is still early in the development cycle, the exact nature of upcoming milestones are still unclear. Potential milestones include Audio and Tooling, but these could be merged or split into fewer or more milestones as the scope discovery process continues.

Development

I would strongly recommend using either Visual Studio or Jetbrains Rider for development. You can use VSCode and other text editors, but you will miss out on the visual designer and other goodies that come with the full-fledged IDEs.

  • As a prerequisite, ensure all NuGet packages are installed.

  • To build, either click the Build button in your IDE, or run dotnet build in the project root directory.

  • The final output for debugging and running is the Ameko.Desktop project

  • Holo and Ameko follow XDG directory guidelines

  • Ameko and Ameko.Desktop use .NET 8.0

  • AssCS and Holo use .NET Standard 2.1

Licensing

  • Ameko and Ameko platform projects (Ameko.Desktop, etc) are licensed under the GNU GPL v3 license.
  • Libraries developed for Ameko (AssCS, Holo, FFMS2CS, etc) are licensed under the BSD 3-Clause license.
  • For more information, see the license.txt file under each project.

About

Cross-platform editor for Advanced Substation Alpha (ASS) subtitles

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages