# Install the vm management software: VirtualBox and Vagrant
# VirtualBox: https://www.virtualbox.org/wiki/Downloads
# Vagrant: http://www.vagrantup.com/downloads-archive.html
# VirtualBox 4.2.24 and Vagrant 1.6.3 work together

# Install git from: http://git-scm.com/downloads
#
# Grab this project
# git clone https://github.com/greghuc/coderdojo-scriptcraft-server.git
# cd coderdojo-scriptcraft-server
#
# Run commands to bootstrap the vm
# vagrant up
# When prompted, specify a 'bridged network interface': Wi-Fi or Ethernet
# Go with the option that the CoderDojo class uses to access the local network.
# The virtual machine will be visible on this local network for the class to connect to.
# Now wait some time whilst the vm bootstraps..

# Run commands to start the Scriptcraft server
# Start by logging into the vm
# vagrant ssh
# cd /vagrant/server
# And run the Scriptcraft server!
# ./run-server.sh

# To stop the Scriptcraft server
# stop

# To shutdown the vm
# exit (assuming you're logged into the vm using vagrant ssh)
# vagrant halt (in the hosting box)

# To restart the vm
# vagrant up
# To log back in
# vagrant ssh

# NOTE: we will refer to your Minecraft username as $username
#
# = Enable the Scriptcraft classroom plugin on the Minecraft server =
#
# More info at: https://github.com/walterhiggins/ScriptCraft/blob/master/docs/API-Reference.md#classroom-plugin
# From the minecraft server console, run..
# jsp classroom on
#
# = Check you can connect your Minecraft client to the server =
#
# First, open a new terminal and grab the server ip address (i.e of the vm)
# vagrant ssh
# ifconfig
# and look for something like: inet addr:192.168.0.57, in the eth0 or eth1 sections
# Then load up the Minecraft client on your laptop
# Create a user profile, setting the Minecraft version to match that of server (can find version in server log). Currently 1.8.8
# Hit 'Play', 'Multiplayer' then 'Direct Connect' 
# Enter the server ip address (192.168.0.57 in our example case) and 'Join server'
# Hopefully you've connected to the server :-)

# = Check you can run Javascript from your Minecraft client = 
#
# So you've connected to the server with your Minecraft client.
# From the client, load the console with '/' and run..
# js 1 + 1
# If the answer is 2.0, you're running Javascript with Scriptcraft

# Check you can copy a Minecraft mod into the server-shared directory, and that it runs.
# The following vm directory is network-shared: /vagrant/server/scriptcraft/players
# It should be accessible from mentors and kids' laptops as:
# //$server-ip-address/players (//192.168.0.57/players in our example case)
# or smb://$server-ip-address/players (depends on OS)
# Try connecting to this directory
# 
# Let's try copying a Minecraft mod into this directory
# First (from inside the vm), ensure there's a subdirectory in /vagrant/server/scriptcraft/players named after your Minecraft username
# So in our example: /vagrant/server/scriptcraft/players/greghuc
# This directory will exist already if you connected your Minecraft client after switching classsroom mode on. Otherwise, create the directory.
# Now (on your laptop), create greet.js, with the contents:
#
exports.hi = function( player ){
  echo( player, 'Hi ' + player.name);
};

#
# Using the network-share, copy greet.js to ...players/$username (players/greghuc in our example)
#
# Wait a few seconds, then run from the Minecraft console
# js $username.hi(self);
# We'd run greghuc.hi(self) in our example
# If the result is 'Greetings $username, everything worked!