Stendhal on Eclipse

• Play
  • Manual
  • Beginner's Guide
  • FAQ
  • Ask for Help
  • Events
  • Videos
  • Rules
  • Groups
• World
  • Atlas
  • Dungeons
  • NPCs
  • Levels
  • Creatures
  • Items
  • Quests
  • Games
  • History
  • Achievements
  • Houses
• GMs
  • Administration
  • How to be a GM
  • Scripts
  • Guide for admin
• Contribute
  • Chat
  • Bugs
  • Testing
  • Graphics
  • Sound
  • Item Ideas
  • Atlas
  • Creature Ideas
  • Quest Ideas
  • NPC Ideas
  • Events Ideas
  • Achievement Ideas
  • Open Tasks
• |
• Extend
  • How to add items
  • How to add Creatures
  • How to add quests
  • How to add NPCs
  • How to create maps
• Develop
  • CVS (Source Code)
  • Bugs
  • Meetings
  • Testing
  • Code Design
  • Jenkins
  • Ideas
  • Open Tasks
  • Patches
  • API Reference

• Build & Host
  • Building
  • IDEs
  • Hosting
• |
• Misc.
  • Third Party Projects

This guide describes how to setup a development environment in Eclipse for Stendhal.

Get Java

• If you can play Stendhal, you already have Java and can skip this step.
• If you do not have java installed, please download it https://java.com
  (if you are on Linux, use your packet manager)

Get Node.js

• https://nodejs.org (optional: for building & using web client)

Get Eclipse

• Go to https://www.eclipse.org/downloads/
• Download: "Eclipse IDE for Java Developers"
• Unzip the download and run Eclipse
• In Eclipse, close the "Welcome" window

You can click on the following images to see them in large.

• 

  On the first run of Eclipse, this "Welcome" window is shown. Please close it.

• 

  Typical window layout with the Package Explorer on the left hand side and an empty area for editors in the middle

Note: If you installed Eclipse in Ubuntu via a package manager, also install: "eclipse-egit"

New Project from Git

In Eclipse:

• Open menu "File -> Import
• In the dialog select: "Git -> Projects from Git" and click "Next".
• Select "Clone URI" and click "Next".
• Fill in the following information:
  • URI:
    • GitHub readonly: https://github.com/arianne/stendhal.git
      (if you have a github account, please go to https://github.com/arianne/stendhal and click on "Fork" to create you own copy of the repository and then use that in Eclipse instead)
    • GitHub read/write (SSH): git@github.com:arianne/stendhal.git
• The result of the fields are filled in automatically, click "Next"
• On the Branch selection page, keep everything selected and click "Next"
• Under "Destination" choose the directory where you want to download the source code and select "Next".
• Eclipse will now download Stendhal from git, this may take a while
• "Import existing projects" and select "Next"
• "Finish" import of project Stendhal

Click on the screenshots to enlarge them, if you need help with any of the steps:

• 

  Import
  

• 

  Import from Git

• 

  Clone URI

• 

  Fill in URI and watch the remaining fields to be filled automatically

• 

  Just click "next" on branch selection

• 

  Just click "next" on destination

• 

  Wait for the download to complete. This may take quite a while

• 

  Import existing project

• 

  Confirm import of project "Stendhal" by clicking finish

Trouble Shooting

After completing the import wizard, Eclipse should look like the following screenshot:

There is a project called "stendhal" listed in the Package Explorer view. There may be a tiny yellow triangle in front of the blue project icon. But if you see a red circle or a red exclamation mark, something went wrong. In this case there will be an error in the "Problems" view at the bottom.

Start StendhalServer

• In the toolbar there is the "Debug" button, which looks like a little, green bug. There is a little black arrow on the right side of it.

• This will open a menu, please choose "Debug configurations ..." ("Open Debug Dialog..." on older versions)
• Then in the dialog select "Java Application" and click on the "new" icon in the top left corner.

Name: StendhalServer
Main class: games.stendhal.server.StendhalServer

• All other settings ("include system libries", "Stop in main", ... can be left at their default value.
• on the [Arguments] tab: VM arguments: -Xmx128M
• on the [Classpath] tab: click "UserEntries" - button "Advanced" - (*) add folder | OK - and select the "stendhal" project root folder | OK
• button [Debug]

And then the server should be started.

NOTE: On newer Eclipse versions, the [Classpath Entries] are under Dependencies tab.

Start Stendhal Client

1. Open games.stendhal.client.update.Starter.java in the editor
2. Then again the small black arrow on the right side of the green bug.
3. Select "Debug Configurations" (or "Run Configurations...").
4. Select Java Application and click the "New" button in upper-left corner.
5. On the [Classpath] tab select "User Entries" - button "Advanced" - (*) add folder | OK - and select the project root folder. | OK

Making patches

If you have modified and tested the code and want to send us a patch, please see How To Create Patch For Stendhal.

Running JUnit Tests in Eclipse

This is an advanced topic. If you make changes to the Java code, it is a good idea to run the automatic test.

Setting up JUnit tests in Eclipse:

1. Click the arrow next to either the green "Run" or "Debug" button.
2. Select "Run/Debug Configurations...".
3. Select "JUnit" in the left column and press the "New launch configuration" at the top of left column.
4. Give it a unique name, like "Stendhal Tests".
5. Select "Run all tests in the selected project, package or source folder".
6. OPTIONAL: (this step simply reduces the number of directories that Eclipse will search in for tests)
   1. Press "Search".
   2. Select "tests" folder under Stendhal root directory and press "OK".
7. Under "Test runner" select "JUnit 4".
8. Under "Classpath" tab select "User Entries" and press "Advanced" on the right panel.
   • NOTE: There should already be a folder under "User Entries" with a "(default classpath)" suffix. Do not delete this folder.
9. Select "Add Folders" and press "OK".
10. Select the Stendhal root folder and press "OK".
11. Now click "Add JARs..." on the right panel.
12. Under the Stendhal root folder select all the .jar files in libs and press OK.
13. Now press "Apply" to save the configuration or "Run" to save and run it.