Awesome
Eliza Chatbot Setup Guide
This guide will walk you through the installation and setup of the Eliza chatbot on a Debian-based WSL (Windows Subsystem for Linux) system or bare metal Debian install.
Prerequisites
- WSL 2 (Windows Subsystem for Linux) capable Windows machine. https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi
- Debian distribution on bare metal.
Installation Steps
-
Open Command Prompt and install Debian on WSL by running the following command: (Skip this if you are running Debian bare metal)
wsl --install -d debian
-
Once the installation is complete and Debian boots up, become the root user:
sudo su
-
Clone and run the setup:
cd ~ apt install -y git git clone https://github.com/HowieDuhzit/Eliza-Installer.git cd Eliza-Installer chmod +x setup.sh ./setup.sh
This will install all necessary dependencies and prompt you to name your character, edit the ENV file, create a character file and then run the rest of the install loading the default character.
-
Exit the bot:
exit
-
Navigate into the Eliza directory:
cd eliza export NVM_DIR="${XDG_CONFIG_HOME:-$HOME}/.nvm" [ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh" pnpm start --characters="characters/YOUR_CHARACTER.character.json"
This will start the Eliza chatbot using your customized character.
Additional Notes
- If you need to make further customizations, you can modify the
.env
file and the individual character JSON files located in~/Eliza-Installer/eliza/characters/
. - To stop the Eliza chatbot, type
exit
in the terminal.
Troubleshooting
- If you encounter issues with
pnpm
, make sure all dependencies are installed correctly. You can installpnpm
globally by running:npm install -g pnpm
Contributing
Feel free to contribute to this project by opening issues or submitting pull requests to improve the Eliza chatbot or this installation guide.
License
This project is licensed under the MIT License - see the LICENSE file for details.
### Key Sections in the `README.md`:
- **Installation Instructions**: Clear, step-by-step guide for setting up the Eliza chatbot on a Debian-based WSL system.
- **Customizing the Character**: Describes how to edit the `.env` configuration file and customize the character's JSON file.
- **Starting the Chatbot**: A simple command to run the chatbot with a custom character.
- **Troubleshooting**: Provides information about potential issues and how to resolve them.