cnnmmd

Installation: Individual

For example, you can chat with a default 2D character from the GUI workflow (ComfyUI) in the following two steps: [※1][※2][※3][※4]

# install
$ yes | ./manage.sh create cnnmmd_xoxxox_mgrcmf_cmf_tlk_wsp_vox_lcp_001 -d
# launch
$ yes | ./manage.sh launch cnnmmd_xoxxox_mgrcmf_cmf_tlk_wsp_vox_lcp_001 -d

・

Reference: Plugin: cnnmmd_xoxxox_mgrcmf_cmf_tlk_wsp_vox_lcp_001

Here are some other workflows:

・

howmgr

*1

This is the minimum configuration that allows you to chat using only a regular PC (CPU only) (the voice recognition, voice synthesis, and language generation models are all installed on the PC) - the entire installation can be completed in about 10 minutes.

*2

Please note the following points when installing and starting the device:

・

refmod_cnnmmd_xoxxox_ttsvox ... The display appears to have stopped when downloading the voice synthesis model (VOICEVOX).

・

refmod_cnnmmd_xoxxox_tttlcp …… Slow initial startup

*3

With this plugin, the workflow creation app itself (ComfyUI) becomes the client, so there is no need to install or configure a separate client app.

*4

The location of the workflow to apply to ComfyUI is listed on the plugin page above.

Installation: General

◯

Installation: Server cluster

To install this tool, follow these steps: First, obtain and install the Plugin Management Tool from:

・

github.com/cnnmmd/cnnmmd

$ cd ${dirtop} # any folder
$ git clone https://github.com/cnnmmd/cnnmmd
$ cd cnnmmd/manage/bin
$ ./manage.sh create manage

From the management tool, you can add, remove, start, and stop all plugins (including the core of this tool). (It also automatically creates container images and acquires, installs, and configures related apps.) [*1] [*2]

$ cd cnnmmd/manage/bin
$ ./manage.sh create ${plugin} # Add/Update
$ ./manage.sh delete ${plugin} # Delete
$ ./manage.sh launch ${plugin} # Start
$ ./manage.sh finish ${plugin} # Stop

By adding the option "-d", all dependent plugins will be automatically added, removed, started, and stopped. Also, if you set it to automatically enter OK at the prompt (yes | ...), all processing can be done in one step: [*3] [*4] [*5]

# Add/update (get and install all dependent plugins, answer all questions)
$ yes | ./manage.sh create ${plugin} -d
# Launch all plugins including itself and its dependencies
$ yes | ./manage.sh launch ${plugin} -d

◯

Setup: GUI workflow creation environment

The GUI workflow creation environment (ComfyUI) will also be installed automatically as a dependency. The app's interface will be displayed by accessing it as follows:

http://localhost:11001/

If you are using an existing ComfyUI, the steps are as follows:

・

howcmf

◯

Installation: Client (character) group

On the client side (character side), the resources included in each plugin must be installed individually according to the application's usage (the installation method is described in each plugin).

*1

This tool requires one of the following container environments:

・

Windows + Docker Desktop + WSL2 (Linux (Ubuntu)) / Windows + WSL2 (Linux (Ubuntu) + Docker)

・

macOS + Docker Desktop

・

Linux (Ubuntu) + Docker

*2

In the case of a microcontroller (Raspberry Pi), the memory limits may be exceeded depending on the resources to be acquired and executed. In this case, you can take measures such as cross-building for the ARM architecture in a container on your PC and transferring the created resources to the microcontroller (if you are using an ARM-based version of macOS, you can use the built version as is).

*3

This option will create container images with all dependencies and install the necessary servers and engines (note that for engines that use external services (such as OpenAI or NovelAI), you will need to store your API key in a file or change the tool configuration).

*4

However, the confirmation "(y|n)" during installation includes the location of files that need to be set manually (such as API KEY) and whether or not to download copyrighted material - so be sure to keep an execution log and check the contents even after the fact.

*5

The list of plugin repositories is in the following file:

・

cnnmmd/manage/cnf/cnfsrc.txt

Installation: Supplement

To use this tool, you will need a container. You will also need a terminal and file sharing - here's how to set them up and use them: [1][2]

・

howdkr …… Container installation

・

howtrm …… Using the terminal

・

howfsh - Use file sharing (get workflows, edit custom files, etc.)

*1

You can enter commands from the terminal, but you can basically just copy and paste from this installation guide.

*2

The estimated storage usage for a group of containers is:

・

howdkr

Adjustment (Customization)

All files that make up the tool (executable files to configuration files) can be modified, including the main body of the tool. The basic method is to replace files, but some configuration files can be patched (to modify parts or add items): [※1]

You can place multiple custom folders for overwriting under the following folder: [※2]

・

cnnmmd/import_custom/${custom}

・

Reference: cnfcmm

・

Reference: cnfmod

To update the contents of your custom folders (import_custom/${custom}/export/*) to the main tool, run:

$ ./remove.sh && ./append.sh

*1

These adjustments are more flexible when using git, but this customization doesn't require git knowledge - at the expense of manual tracking of the differences between the original and the custom.

*2

You can create as many custom folders as you like, and by applying or excluding them as needed, you can tailor your flow to suit your situation and needs.

Sharing (creating and publishing custom plugins)

You can expose a custom folder as a custom plugin:

1]

Custom folder name: Creator + Library name

2]

Register in any repository (Git format)

3]

Publishing the repository address

Sharing (using custom plugins)

Once a plugin is published, users can use it by adding its address to a patch file in their repository list - any duplicate entries will be overwritten by the patch:

・

cnnmmd/manage/cnf/cnfsrc_custom.txt

・

Format: cnfcmm

Please note that when using plug-ins, sufficient security precautions must be taken. [*1]

*1

Dynamic libraries and dynamically generated code on the relay server run inside the container, but if the plugin runs an environment setup script (if the manage/bin folder contains one of create.sh|delete.sh|launch.sh|finish.sh), that script will be executed on the host side (PC side). Depending on the script's behavior, it may put the host side (PC side) at risk -- for plugins from unknown creators, first just download them (set the script execution item to "-"), and if there is a script, check its contents. Once you understand its behavior, we recommend allowing it to run again (set the script execution item to "+") -- if you cannot understand its behavior, you may decide not to use the plugin:

・

Before checking: cnnmmd/manage/cnf/cnfsrc_custom.txt

<plugin> - ...

・

After checking: cnnmmd/manage/cnf/cnfsrc_custom.txt

<plugin> + ...