From 27b8f714521ca6c2860d7419761048cceea29ad0 Mon Sep 17 00:00:00 2001 From: Tanner Collin Date: Thu, 10 Sep 2020 15:33:52 -0600 Subject: [PATCH] Add readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..cfbe512 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Minecraft Bot + +## Setup + +Assuming Debian / Ubuntu based distro: + +``` +$ sudo apt update +$ sudo apt install build-essential python3 python3-dev python3-pip python-virtualenv python3-virtualenv +$ virtualenv -p python3 env +$ source env/bin/activate +(env) $ pip install -r requirements.txt +``` + +Always make sure the virtual environment is running `(env)`. + +## Running + +``` +(env) $ USERNAME=you@domain.com PASSWORD=supersecret SERVER=example.com python main.py +``` +