Install Java JDK
Install Java JDK
Note: At this stage you need to know if your PC is 64bit or 32bit. If you are not sure, open "Windows Explorer", right click on "Computer" and select "Properties". This opens the Control Panel Homes Page about your PC and in the "System" section against the "System Type" it will say either "32-bit Operating System" or 64.
Install latest Java SE Development Kit 7
1. Go to the Java 7 Downloads Page
2. Click the "Accept License Agreement" radio button
3. Download the "Windows x64" (for 64bit Windows) or "Windows x86" (for 32 bit) Java SE Development Kit. At the time of writing the 64bit file is "jdk-7u75-windows-x64.exe"
4. Run the installer file you have just downloaded. This will try and install to a directory like: "C:\Program Files\Java\jdk1.7.75", which is fine. If the directory says JRE instead of JDK then you have downloaded the wrong file. Don't worry if you have both, the JDK contains a JRE.
Install latest Java SE Development Kit 8
1. Go to the Java 8 Downloads Page
2. Click the "Accept License Agreement" radio button
3. Download the "Windows x64" (for 64bit Windows) or "Windows x86" (for 32 bit) Java SE Development Kit. At the time of writing the 64bit file is " jdk-8u40-windows-x64.exe"
4. Run the installer file you have just downloaded. This will try and install to a directory like: "C:\Program Files\Java\jdk1.8.0_40". If the directory says JRE instead of JDK then you have downloaded the wrong file. Don't worry if you have both, the JDK contains a JRE.
Install Eclipse IDE
I would also recommend specifying exactly which version of Java is used to run Eclipse (the JVM). If you don't, the current default version will be used, which is often the last one you installed. If you decided to install an older version, this can get annoying. So I always tell Eclipse exactly which version to use, leaving no surprises. The version of Java used to run Eclipse, is separate from the version used to run any of your projects, so there is no real reason not to use the latest (Java 8 ).
1. Go to the Eclipse Downloads Page
2. Download the "Eclipse IDE for Java EE Developers" not the basic "Eclipse IDE for Java Developers", grabbing the 64bit or 32bit as appropriate. At the time of writing the latest build is "Luna" and the 64bit file is "eclipse-jee-luna-SR2-win32-x86_64.zip"
3. Decide where you want to install Eclipse. The Eclipse install is nothing more than unzipping the zip file. The default location would usually be "C:\Program Files\eclipse". If you simply extract the zip file, it will create the top level "eclipse" directory.
4. Create a shortcut for Eclipse. Copy the "eclipse.exe" file from your Eclipse directory and paste it as a shortcut onto your desktop.
5. Specify a directory to store your Eclipse configuration. By default Windows will store this in "C:\User\Username\.eclipse" but you should override this if you want to use multiple configurations.
5.1 Create a new folder, I recommend storing it at the same level as your workspace folder but not in your workspace folder. So my workspace folder is "C:\Data\Workspace" and my config directory is "C:\Data\.eclipse". Windows will not let you begin a folder name with a period, so create the folder and drop to the command line and rename it.
5.2 Right click your Eclipse shortcut, click "Properties" and edit the target line. Add the following -configuration F:\Data\.eclipse where the path matches the directory you just created. If the path contains spaces you can surround the path in quotes.
6. Specify the Eclipse JVM.
6.1 Open the Eclipse directory (usually "C:\Program Files\eclipse") and edit the eclipse.ini file. Add the lines below, where the path matches your newest Java release.
Code: Select all
-vm
C:\Program Files\Java\jdk1.8.0_40\bin\javaw.exe
Install Eclipse Gradle Plugins.
1. From within Eclipse, select Help, and Install New Software...
2. Click the "Add" button
3. For name enter "Gradle" and for location enter "http://dist.springsource.com/release/TOOLS/gradle" then click OK
4. From the "Working with:" field select the Gradle address you have just added.
5. Eclipse should now search the address for installable modules. Tick all options, the "Extensions / Gradle Integrations" and the "Uncategorised" option.
6. Click "Next" and the components should start installing (this takes a while). Then click "Next", accept the licence and "Finish" and Eclipse will do the final install.
Getting Maptool from GitHub
1. Go to GitHub
2. Register yourself, then sign in.
3. In the "Search GitHub" field type "maptool" and enter. This will bring up the a few repositories, select "RPTools/maptool" which is Craig's master repository.
4. Click the "Fork" button to make your own copy of the project.
5. Download and install "GitHub for Windows" from https://windows.github.com/
6. Start "GitHub for Windows"
7. Configure Git for Windows with your GitHub username and password. Once your client can connect to GitHub you can make a local clone.
8. Click the + Icon, in the top left.
9. Click "Clone" and you should see your Username and your "maptool" project, which you should select.
10. Click the "Clone" option towards the bottom of the screen, a directory dialogue box should appear.
12. Select your Eclipse workspace directory. This will create a maptool project directory in your workspace.
Build the Maptool Gradle Project
1. Open Eclipse.
2. Select File and Import
3. Select "Gradle Project" and click "Next"
4. Browse to your \maptool directory
5. Click the "Build Model" button. This should search the director and find the parent "Maptool" project and the two child projects, "launcher" and "maptool"
6. Select all projects (click the parent "Maptool" project)
7. Click the "Finish" button. This will start building your project in Eclipse. I had to click a few "Run In Background" boxes at this point, but it completed okay. You should now have a "launcher" and a "maptool" project in your Eclipse workspace.
8. Expand your "maptool" project. You should see "JRE System Library" as one of the project components. It should also say which version and if you have followed the steps exactly as described above, it will be "JRE System Library [jdk1.8.0_40]" where as we actually want a Java1.7 version.
9. To change this, select your "maptool" project, the select "Project" and "Properties" which should open the project properties window.
10. Select "Java Build Path" from the options on the left.
11. Click the "Libraries" tab, select the "JRE System Library" and then click "Edit"
12. Click the "Alternate JRE" option and then press the "Installed JREs..." button.
13. Click "Add", "Standard VM" and "Next". The click the "Directory" button to navigate to your Java 1.7 directory. Usually "C:\Program Files\Java\jdk1.7.75". Then click "Finish" and "Ok"
14. You should now be able to select "jdk1.7.0_75" as your project JRE and click "Finish" and close the properties window.
15. Now build the project by right clicking the "maptool" project, then "Gradle" and "Tasks Quick Launcher"
16. A small dislogue window should pop up, type "Build" into the Tasks field and press enter. The project should now build and you should see something like:
Code: Select all
[sts] -----------------------------------------------------
[sts] Starting Gradle build for the following tasks:
[sts] Build
[sts] -----------------------------------------------------
Creating Release
:maptool:copyLibs UP-TO-DATE
:maptool:compileJava UP-TO-DATE
:maptool:processResources UP-TO-DATE
:maptool:classes UP-TO-DATE
:maptool:jar UP-TO-DATE
:maptool:assemble UP-TO-DATE
:maptool:compileTestJava UP-TO-DATE
:maptool:processTestResources UP-TO-DATE
:maptool:testClasses UP-TO-DATE
:maptool:test UP-TO-DATE
:maptool:check UP-TO-DATE
:maptool:build UP-TO-DATE
BUILD SUCCESSFUL
Total time: 2.434 secs
[sts] -----------------------------------------------------
[sts] Build finished succesfully!
[sts] Time taken: 0 min, 2 sec
[sts] -----------------------------------------------------
1. Select your "maptool" project
2. Click "Run" and "Run Configurations..." which will open a dialogue window.
3. Select "Java Application" from the left and then create a new configuration by clicking the "new" button.
4. Make sure the project field says "maptool"
5. In the Main Class field enter "net.rptools.maptool.client.MapTool" or click the "Browse" button and search for "maptool"
6. Click "Apply"
7. Click "Run", this should now launch Maptool 1.4
If you got through all that, congrats!
Extras
Install Albeille
1. Go to the Albeille Downloads page and download the latest binaries. This is a close project so they are quite old. The binaries are jar files so you can simply unzip the folder to anywhere on your PC, such as "C:\Program Files (x86)\abeille-2.1.0_M3"
2. Launch the Designer by running the "designer.jar" file in the "abeille-2.1.0_M3" directory. If you have installed Java as described above, you can just right click the file and select "Open"
3. Once the Designer is running, you need to create a new project for the Maptool forms. Call this file "maptool.jfpr" and save it anywhere you like, BUT NOT in the Eclipse Maptool project directory, as you do not want this file to become part of the Maptool project and is only used by you locally.
4. Add the Maptool resource directory as a Source path for your Abeille Project. On the Abeille Project Settings screen you should see a button in the Source Tab to "Add Path". Click this and navigate to the resource directory. For example, if your Eclipse workspace directory was "C:\Workspace" and your top level Maptool project was called "C:\Workspace\maptool" you should add the path "C:\Workspace\maptool\maptool\src\main\resources". This is very important, otherwise the Albeille Designer will save the local path names into the designer files rather than the relative paths that are needed for proper distribution.
Install e(fx)clipse Plugin
1. From within Eclipse, select Help, and Install New Software...
2. Click the "Add" button
3. For name enter "e(fx)clipse" and for location enter " http://download.eclipse.org/efxclipse/u ... .2.0/site/" then click OK
4. From the "Working with:" field select the e(fx)clipse address you have just added.
5. Eclipse should now search the address for installable modules. Tick all options, the "e(fx)clipse - install" and the "e(fx)clipse - single components" option.
6. Click "Next" and the components should start installing (this takes a while). Then click "Next", accept the licence and "Finish" and Eclipse will do the final install.
Install JavaFX Scene Builder
The JavaFX Scene Builder application has been handed over to the open source community and as a consequence it can be hard to find the Scene Builder install. The last Oracle version can be found on the JavaFX Scene Builder Archive page.
1. Download the "Windows 32/64 bit (msi)" from the "JavaFX Scene Builder 2.0 Related Downloads" section found towards the bottom of the page.
2. Execute the msi file as normal. This will install the application and make a file associatino to the FXML extension.
3. You should now be able to open FXML files from within Eclipse with Scene Builder.
Installing DiceLib and RpLib in Eclipse
If you want to play with any of the basic dice rolling functions you will need to modify the DiceLib sub-project. To do this you follow the same steps as for Maptool but will one additional step. To build the dicelib project, it is necessary to run gradle with the "-Pversion" parameter as described below.
Configure Gradle for Dicelib and RpLib
1. Open Eclipse
2. Select Window and Preferences
3. Expand the Gradle option and select Arguments
4. In the "Program Arguments(requires Gradle1.0-rc-2)" section, click the "Use:" radio button and enter "-Pversion=1.4.0.1-SNAPSHOT" into the text field.
5. Then click "Apply" and close the window.
Getting Dicelib from GitHub
1. Go to GitHub
2. Register yourself, then sign in.
3. In the "Search GitHub" field type "dicelib" and enter. This will bring up the a few repositories, select "RPTools/dicelib" which is Craig's master repository.
4. Click the "Fork" button to make your own copy of the project.
5. Download and install "GitHub for Windows" from https://windows.github.com/
6. Start "GitHub for Windows"
7. Configure Git for Windows with your GitHub username and password. Once your client can connect to GitHub you can make a local clone.
8. Click the + Icon, in the top left.
9. Click "Clone" and you should see your Username and your "dicelib" project, which you should select.
10. Click the "Clone" option towards the bottom of the screen, a directory dialogue box should appear.
12. Select your Eclipse workspace directory. This will create a maptool project directory in your workspace.
Build the Dicelib Gradle Project
1. Open Eclipse.
2. Select File and Import
3. Select "Gradle Project" and click "Next"
4. Browse to your \dicelib directory
5. Click the "Build Model" button. This should search the directory and find the "dicelib" project
6. Click the "dicelib" project
7. Click the "Finish" button. This will start building your project in Eclipse
8. Now build the project by right clicking the "dicelib" project, then "Gradle" and "Tasks Quick Launcher"
9. A small dialogue window should pop up, type "build" into the Tasks field and press enter. The project should now build and you should see something like:
Code: Select all
[sts] -----------------------------------------------------
[sts] Starting Gradle build for the following tasks:
[sts] build
[sts] -----------------------------------------------------
:compileJava UP-TO-DATE
:processResources UP-TO-DATE
:classes UP-TO-DATE
:jar UP-TO-DATE
:assemble UP-TO-DATE
:spotlessJavaCheck
:spotlessCheck
:compileTestJava UP-TO-DATE
:processTestResources UP-TO-DATE
:testClasses UP-TO-DATE
:test UP-TO-DATE
:check
:build
BUILD SUCCESSFUL
Total time: 1.571 secs
[sts] -----------------------------------------------------
[sts] Build finished succesfully!
[sts] Time taken: 0 min, 1 sec
[sts] -----------------------------------------------------
1. Right click you "maptool" project in Eclipse and select "Properties"
2. Click "Java Build Path"
3. Select the "Projects" tab
4. Click the "Add..." button and select the dicelib project
5. Run Maptool from Eclipse as normal