Skip to content

Latest commit

 

History

History
163 lines (98 loc) · 5.59 KB

INSTALL.md

File metadata and controls

163 lines (98 loc) · 5.59 KB

Install

What works (has been tested):

Table of contents:

Docker version used to build the images is 17.09.0-ce

Currently supports only Python >= 3.6, but Py2/3 support is planned soon.

Ubuntu

Docker

Based on https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/

Copy-paste script into terminal:

sudo apt-get update
sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common
# add docker repository
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
# install docker
sudo apt-get update
sudo apt install -y docker-ce=17.09.0~ce-0~ubuntu
# Make sure you can run docker without sudo
# (based on https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user)
sudo usermod -aG docker $USER
# Log out and log back in so that your group membership is re-evaluated
# (close and open terminal window).
# Someone had to restart their entire machine, but that should not be necessary.

Test to check install was successful:

docker run hello-world

Now build the images required to run sc-docker. Enter the docker directory and run build_images.sh. Now you're setup to install scbw to manage the game containers.

You can manually download docker of specified version if it is missing from list of packages. For example

Python & pip

(use python3.6 instead of just python)

Lazy version with a lot of sudo (based on this)

sudo add-apt-repository ppa:jonathonf/python-3.6
sudo apt-get update
sudo apt-get install -y python3.6
curl https://bootstrap.pypa.io/get-pip.py | sudo python3.6
sudo pip3.6 install scbw
scbw.play --install

VNC

Install RealVNC viewer for viewing GUI headful modes from the docker images.

Save the executable in PATH so that it can be launched as vnc-viewer

Something like

sudo ln -s [where-you-put-vnc] /usr/bin/vnc-viewer

Quick links:

Windows

Docker

You may want to read through manual for installing docker on Windows for troubleshooting.

You may need to turn on virtualization support for your CPU (in BIOS).

Test in power shell to check install was successful:

docker run hello-world

When docker prompt to share disk C, agree on that.

Enter yor credentials:

Sometimes popup for entering your credentials could appear after VNC window, so don't miss it.

Now build the images required to run sc-docker. Enter the docker directory and run build_images.ps1. Now you're setup to install scbw to manage the game containers.

Python & pip

Download and install Python 3.6 release from Python releases for Windows

You might need to add python / pip to PATH.

Install scbw package in PowerShell:

pip install scbw
scbw.play --install

VNC

Install, and rename binary to vnc-viewer, add the folder with the vnc-viewer binary to PATH.

Mac

Docker

You may want to read through manual for installing docker on Mac for troubleshooting.

Test in terminal that install was successful:

docker run hello-world

You might need to add /Library folder in File Sharing settings.sh

Now build the images required to run sc-docker. Enter the docker directory and run build_images.sh. Now you're setup to install scbw to manage the game containers.

Python & pip

Download and install Python 3.6 release from Python releases for Mac Os X

Install scbw package:

pip3.6 install scbw
scbw.play --install

VNC

Create a launcher in /usr/local/bin/vnc-viewer:

#!/bin/sh
/Applications/VNC \\Viewer.app/Contents/MacOS/vncviewer "$@"

(of course, update path as necessary).