chore: move characters out to submodule (#3509)

* cli utility v1

* set name to elizaos

* add cli

* set bin/author

* make more executable

* bump lock

* dynamically update version from package.json, update description

* bump

* fix branding

* move out characters

* add characters to be submoduled in

* character submodule, CLI plugin commands, include both Discords

* clean adapters out

* add back sqlite's README

* add more overrides per audit

* audit

* Checkout submodules so characters are available for tests

* get types inline with express 4.x

* remove action, aliases, clean up

* bump lockfile

* upgrade turbo to 2.4.2

* fix integration tests (cast return as Router)

---------

Co-authored-by: Shakker Nerd <[email protected]>

.github/workflows/integrationTests.yaml

@@ -17,6 +17,8 @@ jobs:
       TURBO_REMOTE_ONLY: true
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true  # Ensures submodules are checked out
 
       - uses: pnpm/action-setup@v3
         with:

.github/workflows/smoke-tests.yml

@@ -17,7 +17,8 @@ jobs:
       TURBO_REMOTE_ONLY: true
     steps:
       - uses: actions/checkout@v4
-
+        with:
+          submodules: true  # Ensures submodules are checked out
       - uses: pnpm/action-setup@v3
         with:
           version: 9.15.0

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "characters"]
+	path = characters
+	url = https://github.com/elizaos/characters

README.md

@@ -62,7 +62,7 @@ cp .env.example .env
 pnpm i && pnpm build && pnpm start
 ```
 
-### Manually Start Eliza (Only recommended for platform development)
+### Manually Start Eliza (Only recommended for plugin or platform development)
 
 #### Checkout the latest release
 
@@ -76,6 +76,12 @@ git checkout $(git describe --tags --abbrev=0)
 # git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
 ```
 
+If you would like the sample character files too, then run this:
+```bash
+# Download characters submodule from the character repos
+git submodule update --init
+```
+
 #### Edit the .env file
 
 Copy .env.example to .env and fill in the appropriate values.
@@ -137,6 +143,12 @@ For detailed instructions on using the start script, including character managem
 
 ---
 
+### Add more plugins
+
+1. run `npx elizaos plugins list` to get a list of available plugins or visit https://elizaos.github.io/registry/
+
+2. run `npx elizaos plugins add @elizaos-plugins/plugin-NAME` to install the plugin into your instance
+
 #### Additional Requirements
 
 You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
@@ -153,7 +165,7 @@ pnpm install --include=optional sharp
 
 ---
 
-### Deploy Eliza in one click 
+### Deploy Eliza in one click
 
 Use [Fleek](https://fleek.xyz/eliza/) to deploy Eliza in one click. This opens Eliza to non-developers and provides the following options to build your agent:
 1. Start with a template
@@ -167,7 +179,8 @@ Click [here](https://fleek.xyz/eliza/) to get started!
 ### Community & contact
 
 - [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
-- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
+- [elizaOS Discord](https://discord.gg/elizaos). Best for: hanging out with the elizaOS technical community
+- [DAO Discord](https://discord.gg/ai16z). Best for: hanging out with the larger non-technical community
 
 ## Citation