Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Batcastle authored Dec 29, 2021
1 parent 33762e8 commit 42b687b
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 1,45 @@
# Contributing to Monika Text-To-Speech

## Engines
Developers are welcome to implement support for other Text-To-Speech Engines, such as Google Text-To-Speech, 15.ai, or others. However, a new engine must follow the following guidelines:
1. The engine **must** be either:

a) open-source

or

b) proprietary, used with permission from the original developer, at no cost to the end-user or the developers of this submod

2. The engine **must** work offline.
3. The engine needs to support some form of text formatting to indicate pauses, emphasis, etc. [SSML](https://en.wikipedia.org/wiki/Speech_Synthesis_Markup_Language) is the formatting used internally in Monika Text-To-Speech, so please stick to that.
4. The engine should support using different voices. This is especilly important for engines that have voices that, by default, are reminicent of popular voice assistants such as [Google Assistant](https://www.youtube.com/watch?v=5WEt-j7N7N8), [Alexa](https://www.youtube.com/watch?v=7ya8ahjnfnE), [Siri](https://youtu.be/zOJBGZmCZYU?t=7), [Mycroft](https://www.youtube.com/watch?v=71RwUTnGJbI), or [Cortanta](https://www.youtube.com/watch?v=YFweSyEQiv0)

## Voices


## Platforms

### Operating Systems
#### Linux
Monika Text-To-Speech is a Linux-first Submod. If a new feature doesn't work on Linux, it won't be added until it does. The exception to this is different Text-To-Speech Engines.

Monik Text-To-Speech primarily supports and is tested against Debian-based distros. But Arch-based, Red Hat-based, and indepedent distros will also be supported to the best of our ability.

#### Windows
As the majority of the Monika After Story community is on Windows, we are required to support this OS. Unfortunetly Windows has some unique quirks, being one of the few remaining DOS-based operating systems left.

#### Mac OS
Mac OS is difficult to support without a Mac of some sort. Developers on Mac are strongly encouraged to contribute!


#### BSD
BSD-based operating systems may be hit-and-miss with DDLC and Ren'Py. As such, we have no intentions of supporting BSD-based operating systems.


#### Other
Other operating systems, including but not limited to: Haiku OS, Temple OS, React OS, and FreeDOS; are not supported.

### CPU Architectures


## Planned Features

0 comments on commit 42b687b

Please sign in to comment.