Home

Everybody not a developer

Please visit https://www.marginallyclever.com/ and choose your version of Evil Overlord for more information.

Developers

How to get started hacking on the Evil Overlord project

Technical Requirements for Evil Overlord Java Application

• Java Development Kit [version 8+]

IDE and build tools notes

Evil Overlord uses Apache Maven for dependency management and build artifact configuration. In order to easily build the source code, you might want either an IDE with Maven support, or have Maven installed as a standalone executable accessible on the command line. An operating system agnostic Maven “wrapper” executable is also provided to get you started as soon as possible, see the Quick start section for more details.

IDEs known to be used by project contributors

• Eclipse IDE for Java Developers [Indigo and up, 3.7+]*see note below
• IntelliJ IDEA

Note If your Eclipse is older than Indigo, you still have the option of using it. You will just need to provide Maven integration via the m2e Eclipse plugin. Versions 3.7+ contain the m2e plugin in the download for “Eclipse IDE for Java Developers” whereas previous versions did not.

Standalone Maven

• Apache Maven [version 2.2.1+, 3.3.3 recommended]

Quick start

git clone https://github.com/i-make-robots/Evil-Overlord.git --branch dev ~/Evil-Overlord
the above snippet is all one command, GitHub/textile formatting is splitting it onto two lines.
cd ~/Evil-Overlord
script/bootstrap

The previous command line snippets will clone the latest development branch to your home directory, change directory into your newly cloned git repository, and run the bootstrap script that downloads an Apache Maven wrapper, downloads project dependencies and installs the project into your local Maven repository.

Setup Steps

1. If you don’t already have it, clone the Evil Overlord dev branch to a folder on your computer.
   @git clone https://github.com/MarginallyClever/Makelangelo.git —branch dev ~/Evil-Overlord @
   Note: the above snippet is all one command, GitHub/textile formatting is splitting it onto two lines.
   Also Note: ~/Evil-Overlord directory can be a path of your choice.
2. Read the IDE Specific Steps to learn how to configure your IDE for Evil Overlord development.

IDE Specific Steps

Eclipse

1. Start Eclipse, then choose File > Import > Maven > Existing Maven Projects > Select root directory > Browse > find where you cloned github/Evil-Overlord > Ok > uncheck "Copy projects into workspace > Finish
2. Choose Package Explorer > Right click on Evil Overlord > Maven > Update project. Wait while it downloads and configures dependencies
3. Select Right click on Evil Overlord > Run As > Java Application.

Evil Overlord should run! Make changes to the code and run again to see the effect.

IntelliJ

Instructions for IntelliJ have not yet been written.

Exporting a jar file

See Instructions for exporting a jar file for release.

Further reading for exporting a jar in Maven

• http://www.mkyong.com/maven/how-to-create-a-jar-file-with-maven/

API documentation

The API documentation is available on github.io

Contributing

When you are ready to share you changes, send us a pull request.

Don’t forget to check our issues list to see the roadmap and our list of current challenges.

Help

Please visit Evil Overlord support forums

Thanks

Thank you to Chris Mills for contributing these instructions.