Coefontuber

https://github.com/your-diary/coefontuber
Admin
Coefontuber is an interactive, cross-platform CUI client for CoeFont that allows users to speak with...
Tokens:665
Snippets:6
Trust Score:6.2
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Execute Custom Sound Effect with Coefontuber

Source: https://github.com/your-diary/coefontuber/blob/master/README.md

This example demonstrates how a custom prefix defined in the configuration file (e.g., 'echo') is interpreted. When '!echo hello world' is input, Coefontuber executes the 'play' command with the specified sound effect arguments on the generated WAV file.

```bash
play hello_world.wav echo 0.8 0.88 60 0.4
```

--------------------------------

### Run Coefontuber Interactive Session

Source: https://github.com/your-diary/coefontuber/blob/master/README.md

This command executes the compiled Coefontuber application, starting an interactive command-line interface session.

```bash
./coefontuber
```

--------------------------------

### Configure Coefontuber with JSON

Source: https://github.com/your-diary/coefontuber/blob/master/README.md

This JSON snippet shows an example configuration file for Coefontuber. It includes settings for CoeFont API access (access_key, client_secret, font_uuid, speed), readline behavior, output directory, timeout, and custom sound effect prefixes. The 'coefont' section is typically the only part users need to modify.

```json
{
    "coefont": { 
        "access_key":    "vWuJOxgUZcJGNV4aCZA0dXHlK",
        "client_secret": "y5Fsd7GDfspJnFaqszqOsxSF729je6SecIkevyC6",
        "font_uuid":     "6c0540f7-9639-4d2b-ae8c-43572d9d7f79",
        "speed":         1.0
    },
    "readline": { 
        "vim_mode":     false,
        "history_file": "./.history"
    },
    "output_dir":  "./wav",
    "timeout_sec": 10,
    "custom_prefix_list": [
        {
            "prefix": "echo",
            "args": [
                "echo",
                "0.8",
                "0.88",
                "60",
                "0.4"
            ]
        }
    ]
}
```

--------------------------------

### Initialize Coefontuber Configuration

Source: https://github.com/your-diary/coefontuber/blob/master/README.md

This command copies the template configuration file to the active configuration file, allowing users to quickly set up Coefontuber without writing the config from scratch.

```bash
cp ./template_config.json ./config.json
```

--------------------------------

### Build Coefontuber Application

Source: https://github.com/your-diary/coefontuber/blob/master/README.md

This command compiles the Coefontuber Go application, creating an executable file.

```bash
go build
```

--------------------------------

### Coefontuber Built-In Special Commands

Source: https://github.com/your-diary/coefontuber/blob/master/README.md

This section documents the special commands available within Coefontuber's interactive session. These commands provide functionalities like showing help, listing user-defined commands, and managing the CoeFont dictionary.

```APIDOC
Built-In Special Commands:
  !help: Shows help about all of the built-in special commands.
  !list: Shows the list of all of the user-defined special commands.
  !dict: Shows the list of the words registered to CoeFont dictionary.
  !dict <word> <reading>: Registers the word <word> with its pronunciation <reading> to CoeFont dictionary.
  !dict del <word>: Removes the word <word> from CoeFont dictionary.
```
Tokens:
Raw