Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.3 KB

DEVSETUP.md

File metadata and controls

45 lines (34 loc) · 2.3 KB

#Development Setup Guide This guide is for the people that would like to contribute to PhantomBot and do it well. <3

Please have a read on CODESTYLE.md, any code that does not apply to these rules will not get merged.

##General (All other IDE's) This section is for all IDE's not mentioned in this guide.
It's very global, so you might need to take some extra steps to get it to work for you.

  1. Fork the PhantomBot repository.
  2. Check out your for and open it in your favorite IDE.
  3. Set the project Java SDK to 1.8.
  4. Import build.xml into your ANT task manager.
  5. Setup your favorite JavaScript minifier to mangle & minify all sources from ./javascript-sources/ and have it put the output in ./resources/scripts/.
    The most commonly used minifier is UglifyJS with NodeJS.

DONE! Happy coding <3

##JetBrains IntelliJ This section also applies to JetBrains PHPStorm, wich is great for JavaScript, but lacks Java support.
You can get JetBrains IntelliJ here.

  1. Fork the PhantomBot repository.
  2. Open up IntelliJ, so you have the start screen.
    From there you can check out (Check out from Version Control) your fork and open it up.
  3. Open up a file from ./source/ where IntelliJ will ask you for a project SDK. Use SDK 1.8.
  4. Next up mark the directories ./source and ./javascript-source as "Sources Root".
    "Mark Directory As" in the context menu.
  5. Install the "File Watchers" plugin if you haven't already.
  6. Import ./development-resources/watchers.xml into your File Watchers.
    The File Watchers are located in "Settings" under "Tools"
  7. Import build.xml into the ANT task manager.
    IntelliJ might have already asked this of you and you were right in accepting it

DONE! Happy coding <3

##Netbeans You can get Netbeans here.

Yet to be written.

##Eclipse You can get Eclipse here.

Yet to be written.