├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── Vagrantfile
├── civcraft_dev
    └── namelayer-git.sh
├── puppet
    ├── manifests
    │   └── site.pp
    ├── modules
    │   └── .README
    └── third-party
    │   └── .README
├── scripts
    ├── minecraft
    │   ├── control.sh
    │   └── get_and_start_vanilla.sh
    └── spigot
    │   └── get_and_build_spigot.sh
└── vagrant_cleanup.sh


/.gitattributes:
--------------------------------------------------------------------------------
1 | * text eol=lf
2 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .vagrant/
2 | **/*.jar
3 | /minecraft
4 | /spigot
5 | ext.vdi
6 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 Daniel Boston
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # civcraft-vm
  2 | Virtual Machine appliance using Vagrant and puppet to auto provision a Civcraft-compatible testing machine
  3 | 
  4 | ---------
  5 | 
  6 | **DISCLAIMER:** Use of this VM appliance indicates you agree with Minecraft's EULA! If you don't, or don't know what I'm talking about, don't use this VM appliance until you do, and can agree with it.
  7 | 
  8 | ----------------
  9 | 
 10 | My target for this is to get as far along the path to having a working, running Civcraft server at the end of the script as possible. What I have so far:
 11 | 
 12 | 1. Basic VM provisioning
 13 | 
 14 | 2. Java and other dependency installations (git, maven)
 15 | 
 16 | 3. Minecraft server install
 17 | 
 18 | 4. Minecraft server startup
 19 | 
 20 | 5. Spigot server download
 21 | 
 22 | 6. Spigot server replace Minecraft
 23 | 
 24 | with the core mods being in the hands of the developer -- for now. That's next.
 25 | 
 26 | I'll likely also add here *first* some how-tos in terms of getting mods set up that play nice with the server, and will submit refined versions to go in Dr_Jawa and/or Erocs' guides.
 27 | 
 28 | --------------------------
 29 | 
 30 | ## How to use this appliance
 31 | 
 32 | 1. Get git: https://git-scm.com/downloads
 33 | 
 34 | 2. Get Vagrant: https://www.vagrantup.com/downloads.html
 35 | 
 36 | 3. Get VirtualBox: http://download.virtualbox.org/virtualbox/
 37 | 
 38 |     * (check LATEST.TXT for which to download)
 39 | 	
 40 | 	* Note that if you are running Windows 8, be warned that installing VirtualBox's bridge adapter may [break standby and Windows 8 Fast Shutdown](http://www.reddit.com/r/Civcraft/comments/38nrd2/morning_changelog_20150605/crwvoqc).
 41 | 
 42 | 4. Install git (or one of the many GUI clients, ya wuss)
 43 | 
 44 | 5. Install Vagrant (may require restart)
 45 | 
 46 | 6. Install VirtualBox (will disconnect your internet, so log off Civcraft)
 47 | 
 48 | 7. Clone this repository locally: `git clone git@github.com:ProgrammerDan/civcraft-vm.git`
 49 | 
 50 | 8. cd into that repository: cd civcraft-vm
 51 | 
 52 | 9. Issue `vagrant up`. Note, this will take *a long time* so go do other things while waiting.
 53 | 
 54 | 10. SSH into vagrant: `vagrant@127.0.0.1:2222` default password `vagrant`
 55 | 
 56 | 11. Until automated, seek out other resources for setting up Civcraft.
 57 | 
 58 | ----------------------
 59 | 
 60 | ## Setting up Civcraft in your new VM
 61 | 
 62 | 1. The puppet provisioning issued by Vagrant (don't worry about the details) will handle most of the setup.
 63 | 
 64 |     1. Minecraft 1.8.7 will be properly initialized
 65 | 
 66 |     2. EULA will be accepted -- **if you object to this, don't use this VM.**
 67 | 
 68 |     3. Spigot 1.8.7 will be built locally using BuildTools
 69 | 
 70 |     4. Spigot will be installed as the minecraft_server.jar
 71 | 
 72 |     5. Vanilla MC to Spigot conversion will occur.
 73 | 
 74 | 2. Now, test your server by connecting to it: localhost:25565
 75 | 
 76 | Note: If you need to restart your Vagrant for any reason, issue "vagrant reload" at the host terminal.
 77 | 
 78 | 3. Proceed into installing Civcraft server mods.
 79 | 
 80 | --------------------
 81 | 
 82 | ## Setting up your host machine as a development environment
 83 | 
 84 | 1. Install Maven: https://maven.apache.org/download.cgi
 85 | 
 86 | 2. Install a Java Development Environment
 87 | 
 88 |     * Eclipse is good: https://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/lunasr2
 89 | 
 90 |     * IntelliJ is good: https://www.jetbrains.com/idea/download/
 91 | 
 92 |     * Hardcore? Notepad++ is popular: https://notepad-plus-plus.org/download/
 93 | 
 94 |     * Textpad is a good hardcore for Windows: http://www.textpad.com/download/
 95 | 
 96 |     * Badass? Vim: http://www.vim.org/download.php or Emacs: http://www.gnu.org/software/emacs/#Obtaining
 97 | 
 98 | 3. Install git if you haven't already: https://git-scm.com/downloads
 99 | 
100 | 4. Install spigot & craftbukkit into your maven repository:
101 | 
102 |     mvn install:install-file -Dfile=./spigot/spigot-1.8.7.jar -DgroupId=org.spigotmc -DartifactId=spigot -Dversion=1.8.7 -Dpackaging=jar -DpomFile=./spigot/spigot-pom.xml
103 | 
104 |     mvn install:install-file -Dfile=./spigot/craftbukkit-1.8.7.jar -DgroupId=org.bukkit -DartifactId=craftbukkit -Dversion=1.8.7 -Dpackaging=jar -DpomFile=./spigot/craftbukkit-pom.xml
105 | 
106 | --------------------
107 | 
108 | ## Setting up the VM as a development environment
109 | 
110 | Already done! Unlike your local machine, the dev environment has already installed spigot and craftbukkit compiled artifacts into the Maven repository, so you're ready to start developing out of the box.
111 | 
112 | --------------------
113 | 
114 | ## Post set-up in either case
115 | 
116 | 1. Check out your favorite Civcraft mod and start hacking: https://github.com/Civcraft/
117 | 
118 | 2. Most of them are "good" mods and after cloning them locally you can issue: 
119 | 
120 |     * `mvn clean package "-Dbuild.number=Local"`
121 | 
122 |     * That builds the mod, and puts the output jar in ./target off the repository root.
123 | 
124 |     *  The build.number stuff just gives a meaningful assignment to the incremental build number in the POM (maven details, go read up on it).
125 | 
126 | 3. Drop the built jars into the vm's `/minecraft/plugins` folder and restart the minecraft server on the VM.
127 | 
128 | -----------------
129 | 
130 | ## Civcraft Clone TODO
131 | 
132 | Note that currently, Namelayer and Citadel are in constant flux as Rourke and team work on Mercury / Sharding. The following is a stable plugin set:
133 | 
134 |     CivModCore 1.0.3
135 | 
136 |     NameLayer 2.3.5-136
137 | 
138 |     Citadel 3.2.8-130
139 | 
140 | If you want to contribute to these plugins, you're going to need to go to most recent version on the plugin's master branch; I'll help you as I can.
141 | 
142 | ### CivModCore Setup (1.0.3)
143 | 
144 | 1. Grab the latest CivModCore jar from the Civcraft build server, or build locally
145 | 
146 | 2. Put the jar into `/minecraft/plugins`
147 | 
148 | 3. Continue.
149 | 
150 | 
151 | ### Namelayer Setup (2.3.5-136)
152 | 
153 | 1. Grab the latest jar from Civcraft build server, or build locally
154 | 
155 | 2. Put the jar into `/minecraft/plugins`
156 | 
157 | 3. Start the server, observe the errors
158 | 
159 | 4. Shut down the server.
160 | 
161 | 5. Open `/minecraft/plugins/Namelayer/config.yml` -- note the need for username and password
162 | 
163 | 6. Install mysql -- `sudo apt-get install mysql-server`
164 | 
165 |     * It's up to you if you want to set a root password; if you don't you'll be asked a bunch of times.
166 | 
167 | 7. Log in to mysql -- `mysql -uroot -p` with whatever password you set, or omit the `-p` if you did not set one.
168 | 
169 | 8. Create namelayer credentials -- `CREATE USER mc_namelayer IDENTIFIED BY 'minecraft';` -- clearly not high security here.
170 | 
171 | 9. Create a database for this user -- `CREATE DATABASE IF NOT EXISTS namelayer`
172 | 
173 | 10. Give permission to use the database to your user -- `GRANT ALL ON namelayer.* TO mc_namelayer`
174 | 
175 | 11. `exit` the mysql shell.
176 | 
177 | 12. Test your user and database -- `mysql namelayer -umc_namelayer -p` entering in password `minecraft` -- if this gives no errors, you're ready to go.
178 | 
179 | 13. Go back to `/minecraft/plugins/Namelayer/config.yml` and edit it to look like this:
180 | 
181 |     sql:
182 | 	  hostname: localhost
183 | 	  port: 3306
184 | 	  dbname: namelayer
185 | 	  username: 'mc_namelayer'
186 | 	  password: 'minecraft'
187 | 	groups:
188 | 	  enable: true
189 | 
190 | 14. Restart the spigot server.
191 | 
192 | 15. If there are tons of errors, let me know. Any such things are on my to-do to fix this.
193 | 
194 | 16. Stop and restart spigot one last time.
195 | 
196 | ### Citadel Setup (3.2.8-130)
197 | 
198 | 1. If Namelayer is installed, just grab the latest jar from Civcraft build server, or build locally
199 | 
200 | 2. Put the jar into `/minecraft/plugins`
201 | 
202 | 3. Start the server, observe the errors
203 | 
204 | ### Humbug Setup
205 | 
206 | ### FactoryMod Setup
207 | 


--------------------------------------------------------------------------------
/Vagrantfile:
--------------------------------------------------------------------------------
 1 | # -*- mode: ruby -*-
 2 | # vi: set ft=ruby :
 3 | 
 4 | #If api.puppetlabs.com is down or otherwise unreachable, everything will break.
 5 | #There is no workaround currently in place.
 6 | $puppet_update_script  = <<SCRIPT
 7 | cd /tmp
 8 | wget http://apt.puppetlabs.com/puppetlabs-release-precise.deb
 9 | sudo dpkg -i puppetlabs-release-precise.deb
10 | sudo apt-get update
11 | if [ $(puppet --version) != '3.3.1' ]
12 |   then
13 |     sudo apt-get remove puppet -y
14 |     sudo apt-get install puppet -y
15 | fi
16 | SCRIPT
17 | 
18 | 
19 | Vagrant.configure("2") do |config|
20 | 
21 |   # Create `minecraft/` and `spigot/` in the root directory
22 |   # and fills it with scripts before the rest of the vagrantfile runs.
23 |   # This is to separate the civcraft dev environment from instantiated server files
24 |   # so that we don't have a convoluted .gitignore filled with every little edge case
25 |   Dir.mkdir("./minecraft") unless File.exists?("./minecraft")
26 |   Dir.mkdir("./spigot") unless File.exists?("./spigot")
27 |   FileUtils.cp_r Dir.glob('scripts/minecraft/*.sh'), './minecraft/'
28 |   FileUtils.cp_r Dir.glob('scripts/spigot/*.sh'), './spigot/'
29 | 
30 | 
31 |   config.vm.box = "plab"
32 |   # The url from where the 'config.vm.box' box will be fetched if it
33 |   # doesn't already exist on the user's system.
34 |   config.vm.box_url = "http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210.box"
35 | 
36 |   # Create a forwarded port mapping which allows access to a specific port
37 |   # within the machine from a port on the host machine. In the example below,
38 |   # accessing "localhost:8080" will access port 80 on the guest machine.
39 |   config.vm.network :forwarded_port, guest: 25565, host: 25565
40 | 
41 |   # Create a private network, which allows host-only access to the machine
42 |   # using a specific IP.
43 |   # config.vm.network :private_network, ip: "192.168.33.10"
44 | 
45 |   # Create a public network, which generally matched to bridged network.
46 |   # Bridged networks make the machine appear as another physical device on
47 |   # your network.
48 |   # config.vm.network :public_network
49 | 
50 |   # If true, then any SSH connections made will enable agent forwarding.
51 |   # Default value: false
52 |   # config.ssh.forward_agent = true
53 | 
54 |   config.vm.provision :shell, :inline => $puppet_update_script
55 |   # Share an additional folder to the guest VM. The first argument is
56 |   # the path on the host to the actual folder. The second argument is
57 |   # the path on the guest to mount the folder. And the optional third
58 |   # argument is a set of non-required options.
59 |   # config.vm.synced_folder "../data", "/vagrant_data"
60 | 
61 |   guest_puppet_lib = "/tmp/puppet_lib/"
62 |   host_puppet_lib = "./puppet/"
63 |   config.vm.synced_folder host_puppet_lib, guest_puppet_lib
64 |   config.vm.synced_folder ".", "/home/vagrant/host"
65 |   config.vm.synced_folder "./minecraft", "/minecraft"
66 |   config.vm.synced_folder "./spigot", "/spigot"
67 |   config.vm.synced_folder "./civcraft_dev", "/civcraft_dev"
68 | 
69 |   # Provider-specific configuration so you can fine-tune various
70 |   # backing providers for Vagrant. These expose provider-specific options.
71 |   # Example for VirtualBox:
72 |   #
73 |   config.vm.provider :virtualbox do |vb|
74 |     #   # Don't boot with headless mode
75 |     #   vb.gui = true
76 |     #
77 |     # Use VBoxManage to customize the VM. For example to change memory:
78 |   	vb.memory = 2048
79 |       vb.name = "civcraft"
80 |       ext_filename = "ext.vdi"
81 |   	if ARGV[0] == "up" && ! File.exist?(ext_filename)
82 |         vb.customize ["createhd", "--filename", ext_filename, "--size", "51200"] #51200 = 50*1024, ie 50 GB
83 |         vb.customize ["storageattach", vb.name, "--storagectl", "SATA Controller", "--port", "1", "--type", "hdd", "--medium", ext_filename]
84 |   	end
85 |   end
86 | 
87 |   # Enable provisioning with Puppet stand alone.  Puppet manifests
88 |   # are contained in a directory path relative to this Vagrantfile.
89 |   modulepath = guest_puppet_lib + 'modules:' + guest_puppet_lib + 'third-party'
90 |   config.vm.provision :puppet do |puppet|
91 |     puppet.options = "--verbose --debug --parser future --modulepath=" + modulepath
92 |     puppet.manifests_path = host_puppet_lib + "manifests"
93 |     puppet.manifest_file  = "site.pp"
94 |   end
95 | end
96 | 


--------------------------------------------------------------------------------
/civcraft_dev/namelayer-git.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | echo "If you haven't already, config git by issuing"
 4 | echo "    git config --global user.name=yourusername"
 5 | echo "and"
 6 | echo "    git config --global user.email=youremail@someplace.com"
 7 | echo "Press Ctrl+C right now if you haven't."
 8 | sleep 10
 9 | echo "Proceeding..."
10 | 
11 | 


--------------------------------------------------------------------------------
/puppet/manifests/site.pp:
--------------------------------------------------------------------------------
 1 | class dev {
 2 |   package { [
 3 |         'git', 'git-core', 'expect', 'vim', 'screen', 
 4 |         'nano', 'openjdk-7-jdk', 'maven'
 5 |     ]:
 6 |     ensure => latest
 7 |   }
 8 |   package { [
 9 |         'openjdk-6-jdk', 'openjdk-6-jre'
10 |     ]:
11 |     ensure => absent
12 |   }
13 |   exec { 'dev.rightjdk':
14 |     require => Package['openjdk-7-jdk'],
15 | 	path => ["/usr/bin/", "/usr/sbin/", "/bin"],
16 |     command => 'update-java-alternatives -s java-1.7.0*'
17 |   }
18 | }
19 | 
20 | class civcraft {
21 |   require dev
22 |   file { 'civcraft.mcscript':
23 |     path => '/minecraft/get_and_start_vanilla.sh',
24 |     ensure => file,
25 |     mode => '0775'
26 |   }
27 |   exec { 'civcraft.minecraftcreate':
28 |     require => File['civcraft.mcscript'],
29 |     command => '/minecraft/get_and_start_vanilla.sh',
30 |     timeout => 0
31 |   }
32 |   file { 'civcraft.spscript':
33 |     require => Exec['civcraft.minecraftcreate'],
34 |     path => '/spigot/get_and_build_spigot.sh',
35 |     ensure => file,
36 |     mode => '0775'
37 |   }
38 |   exec { 'civcraft.spigotcreate':
39 |     require => File['civcraft.spscript'],
40 |     command => '/spigot/get_and_build_spigot.sh',
41 |     timeout => 0,
42 |     logoutput => true
43 |   }
44 |   file { 'civcraft.spigotcontrol':
45 |     require => Exec['civcraft.spigotcreate'],
46 |     path => '/minecraft/control.sh',
47 |     ensure => file,
48 |     mode => '0775'
49 |   }
50 |   exec { 'civcraft.spigotserver':
51 |     require => File['civcraft.spigotcontrol'],
52 |     command => '/minecraft/control.sh start',
53 |     timeout => 0, 
54 |     logoutput => true
55 |   }
56 | }
57 | 
58 | class civcraftdev {
59 |   require civcraft
60 |   exec { 'civcraftdev.prep_all':
61 |     command => 'cp /civcraft_dev/*.sh /civcraft_build/'
62 |   }
63 |   file { 'civcraftdev.namelayer':
64 |     require => Exec['civcraftdev.prep_all'],
65 |     path => '/civcraft_build/namelayer-git.sh',
66 |     ensure => file,
67 |     mode => '0775'
68 |   }
69 | }
70 | 
71 | node default {
72 |   include dev
73 | 
74 |   include civcraft
75 | }
76 | 


--------------------------------------------------------------------------------
/puppet/modules/.README:
--------------------------------------------------------------------------------
1 | Future location of puppet modules
2 | 


--------------------------------------------------------------------------------
/puppet/third-party/.README:
--------------------------------------------------------------------------------
1 | Future location of third-party puppet modules
2 | 


--------------------------------------------------------------------------------
/scripts/minecraft/control.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | cd /minecraft
 4 | 
 5 | if [[ "$1" == "start" ]]
 6 | then
 7 | 	if [ -e '.mc_screen' ]
 8 | 	then
 9 | 		echo Minecraft is already in a screen session, joining to it now...
10 | 		sleep 3
11 | 		screen 
12 | 	else
13 | 		screen -d -S mc_screen -m -p 0 bash -c 'java -Xmx1500M -Xms500M -XX:MaxPermSize=256M -jar minecraft_server.jar nogui'
14 | 		touch .mc_screen
15 | 	fi
16 | elif [[ "$1" == "stop" ]]
17 | then 
18 | 	if [ -e '.mc_screen' ]
19 | 	then
20 | 		screen -S mc_screen -p 0 -X stuff 'stop
21 | '
22 | 		rm .mc_screen
23 | 	else
24 | 		echo Minecraft seems to already be stopped?
25 | 	fi
26 | fi
27 | 


--------------------------------------------------------------------------------
/scripts/minecraft/get_and_start_vanilla.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | wget https://s3.amazonaws.com/Minecraft.Download/versions/1.8.7/minecraft_server.1.8.7.jar -O /minecraft/minecraft_server.jar
 4 | 
 5 | cd /minecraft
 6 | 
 7 | java -Xms500M -Xmx1G -jar minecraft_server.jar nogui
 8 | 
 9 | sed '$ c\
10 | eula=true' -i eula.txt
11 | 
12 | java -Xms500M -Xmx1G -jar minecraft_server.jar nogui &
13 | 
14 | echo Going to give MC some time to get situated.
15 | 
16 | sleep 30
17 | 
18 | if [ -e ops.json ]
19 | then
20 | 	echo 'Making progress, ops file exists'
21 | fi
22 | 
23 | sleep 30
24 | 
25 | if [ -d world ]
26 | then
27 | 	echo 'World folder in place, great!'
28 | fi
29 | 
30 | sleep 30
31 | 
32 | if [ -e logs/latest.log ]
33 | then
34 | 	echo 'Logs in place, good, most recent logs:'
35 | 	tail logs/latest.log
36 | fi
37 | 
38 | sleep 30
39 | 
40 | echo 'We have waited long enough, killing the process.'
41 | 
42 | kill -15 %1
43 | 
44 | sleep 30
45 | 
46 | echo 'Ok, let us move on.'
47 | 


--------------------------------------------------------------------------------
/scripts/spigot/get_and_build_spigot.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | sudo mkdir /spigot-build/
 4 | 
 5 | sudo chown vagrant:vagrant /spigot-build/
 6 | 
 7 | cd /spigot-build/
 8 | 
 9 | wget https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar -O BuildTools.jar
10 | 
11 | git config --global --unset core.autocrlf
12 | 
13 | echo Not sure how long this will take, so sit back and relax.
14 | 
15 | sudo su vagrant -c "java -Xmx1500M -jar BuildTools.jar --rev 1.8.8"
16 | 
17 | if [ -e spigot-1.8.8.jar ]
18 | then
19 | 	cp spigot-1.8.8.jar /minecraft/minecraft_server.jar
20 | 	cp spigot-1.8.8.jar /spigot/
21 | 	cp craftbukkit-1.8.8.jar /spigot/
22 | 	cp Spigot/Spigot-Server/pom.xml /spigot/spigot-pom.xml
23 | 	cp CraftBukkit/pom.sml /spigot/craftbukkit-pom.xml
24 | else
25 | 	echo Failed to generate spigot!
26 | 	exit 404
27 | fi
28 | 
29 | echo Initial install of spigot jars to maven.
30 | 
31 | mvn install:install-file -Dfile=spigot-1.8.8.jar -Dpackaging=jar -DpomFile=Spigot/Spigot-Server/pom.xml
32 | 
33 | mvn install:install-file -Dfile=craftbukkit-1.8.8.jar -Dpackaging=jar -DpomFile=CraftBukkit/pom.xml
34 | 


--------------------------------------------------------------------------------
/vagrant_cleanup.sh:
--------------------------------------------------------------------------------
1 | vagrant destroy
2 | git clean -fd
3 | rm -r .vagrant/
4 | rm -r minecraft/
5 | rm -r spigot/
6 | 


--------------------------------------------------------------------------------