Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 3.74 KB

node.md

File metadata and controls

84 lines (50 loc) · 3.74 KB

Setting up the Everlife Avatar

This document contains instructions for setting up and running the Everlife avatar on a server machine.

Avatar

You can, of course, install the node on your desktop if you like. If you would like a GUI version that you can just install you probably should look at the community node edition.

The advantage of the server version is that it is optimised for running on a VPS on the cloud and can be customised more easily than the packaged community node.

Docker

One option for installation is to use Docker. If you are comfortable using Docker you do not need to install the other pre-requisites like NodeJS and Python as the container is already set up with everything you need.

Docker Install Steps

  1. Install Docker
  2. Run ./run-docker.sh

Mac Setup

Installing on your Mac is simple. You can use a package manager like Homebrew to simplify the package installs.

  1. Install NodeJS LTS Version: 14.16.0 and above
  2. Install Python 2.7
  3. Run ./run-mac.sh

Linux Setup

Setting up on any *-nix machine is simple as well. Use the built in package manager to install the required packages (yum install or apt-get).

  1. Install NodeJS LTS Version: 14.16.0 and above
  2. Install Python 2.7
  3. Run ./run-linux.sh

Windows Setup

Installing on windows requires a bit more setup as we need to set up some *-nix like tools. The simple way to do this is to install a Cygwin distribution.

  1. Install Cygwin: 64 Bit Version or 32 Bit Version
  2. Install NodeJS LTS Version: 14.16.0 and above
  3. Install Python 2.7
  4. Run ./run-win.cmd

Configuration

Your environment, data, and configuration is created under the $HOME/everlife folder. Here you will find your blockchain, wallets, configuration, and so on.

The first time you run, this folder will be set up for you.

Talking to your new bot over Telegram

In order to talk with your avatar over Telegram you need to set up a communication channel with it. The steps for doing this are as follows:

  1. Go to Telegram to create a bot by typing the

    `/newbot`

    command to create your telegram bot.

  2. The BotFather will ask you for a name and username, then generate an authorization token for your new bot. The token is a string that looks something like 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw .

  3. Link this new telegram bot with your avatar. To do this, simply save the telegram token in the cfg.env file located in the data folder somewhere under $HOME/everlife.

    (To find the exact location of your data folder you can check the logs or pass the --info parameter to the run script. For example (./run-mac.sh —info).

Next steps

  1. You should now join the Everlife network through an Avatar Hub. Contact our support channel in discord to get your invite code to join the hub and inform your avatar that you would like to join this Avatar Hub by saying

     /use_invite xxxx

  2. Install and try out various skills

    "install calculator"
"install what-wine"

  3. Do some work and earn EVER, or buy and NFT asset, or play some game, or develop your own skills. The sky’s the limit. Enjoy!

Feel free to provide us your feedback and issues in our discord support channel.