Stendhal on Eclipse: Difference between revisions

← Older edit

Content deleted Content added

VisualWikitext

Revision as of 23:01, 21 June 2015 view source imported>Hendrik Brummermann →New Project from Git ← Older edit		Latest revision as of 18:13, 20 June 2023 view source imported>Hendrik Brummermann →New Project from Git
(50 intermediate revisions by 5 users not shown)
Line 3: 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<br> (if you are on Linux, use your packet manager) == Get Node.js == * https://nodejs.org (optional: for building & using web client) == Get Eclipse== Line 8 ⟶ 16: * Go to https://www.eclipse.org/downloads/ * Download: "Eclipse IDE for Java Developers" * Unzip the download anand run Eclipse * In Eclipse, close the "Welcome" window Line 17 ⟶ 25: File:Eclipse_00a.png\|Typical window layout with the Package Explorer on the left hand side and an empty area for editors in the middle </gallery> Note: If you installed Eclipse in Ubuntu via a package manager, also install: "eclipse-egit" == New Project from Git == Line 25 ⟶ 34: * In the dialog select: "Git -> Projects from Git" and click "Next". * Select "Clone URI" and click "Next". * Fill in the following information:~~<br>URI: <code><nowiki>git://git.code.sf.net/p/arianne/stendhal</nowiki></code>~~ '''URI''': * GitHub readonly: <code><nowiki>https://github.com/arianne/stendhal.git</nowiki></code><br>(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): <code><nowiki>git@github.com:arianne/stendhal.git</nowiki></code> * The result of the fields are filled in automatically, click "Next" * On the Branch selection page, keep everything selected and click "Next" Line 31 ⟶ 43: * 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: Line 40 ⟶ 53: Eclipse 04.png\|Fill in URI and watch the remaining fields to be filled automatically Eclipse 05.png\|Just click "next" on branch selection Eclipse 06.png\|Just click "next" on ~~destionation~~destination Eclipse 07.png\|Wait for the download to complete. This may take quite a while Eclipse 08.png\|Import existing project Eclipse 09.png\|Confirm import of project "Stendhal" by clicking finish </gallery> ==Trouble Shooting==▼ ~~== Configure Project ==~~ After completing the import wizard, Eclipse should look like the following screenshot: ~~<ol>~~ ~~<li>In the New Project wizard select Java -> Java Project (do not select a simple "general" project!) and click "Next".</li>~~ ~~<li>Project name: stendhal ( or whatever you like to call it ).~~ ~~<li>Under the section named "JRE" make sure a Java version 1.5 or higher is selected and click "Finish".</li>~~ ~~<li>Right click on your project folder and select "Properties" in the context menu.</li>~~ ~~<li>Then select "Java Build Path" on the left side of the dialog box.</li>~~ ~~<li>Now remove all existing folders from source path and add the two source folders 'src' and 'tests' by clicking on the "Add Folder..." button</li>~~ [[File:Eclipse 10.png]] ~~<pre>~~ ~~source folder #1:~~ ~~stendhal/src~~ ~~Included:(All)~~ ~~Excluded:(None)~~ ~~Native library location: (None)~~ 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. ~~source folder #2:~~ ~~stendhal/tests~~ ~~Included:(All)~~ ~~Excluded:(None)~~ ~~Native library location: (None)~~ ~~default output folder: stendhal/bin~~ == Start StendhalServer == ~~</pre>~~ <i><span style="color:red;">NOTE:</span> For newer versions of eclipse an asterix () may need to be added manually to "Included". If the project is already checked out just right-click "src" & "tests" in the Package Explorer panel & select <span style="color:blue;">Build Path > Configure Inclusion / Exclusion Filters...</span> Under "Inclusion patterns" select "Add" then input "" and select "OK" then "Finish". Updated screenshots to be added.</i> ~~<li> On the "Libraries" tab: click on the "Add JARs" button and select all the .jar-files in stendhal/libs (some versions of eclipse may automatically import the .jar files).</li>~~ <i><span style="color:red;">NOTE:</span> If project checkout did not complete before the Create New Project Wizard starts you may have to add the .jar files later. To get to the project properties page either select "Project" from the menu bar then select "Properties" or right-click the root folder in the Package Explorer panel then select "Properties" from the drop-down menu. Updated screenshots to be added.</i> ~~<li> Check the text encoding at Project -> Properties -> Resource -> Text Encoding. Set it to UTF-8 unless it is that already.</li>~~ ~~</ol>~~ Eclipse should be able to compile the source code now. There could be a little yellow sign (signalling warning messages) before your project folder but there must not be red X (error messages). The package explorer should now display the "src" folder below the root folder with a different icon, the icon is like a small grid. ▲==Trouble Shooting== ~~menu Windows \| Preferences \| Java \| Installed JREs~~ there should be at least one entry with a valid JAVA_HOME path (make it so so JDK compliance is at least Java 7) ~~==To make it run the server in Debug mode==~~ * 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. [[File:Eclipse_debug_configurations_menu.png]] Line 90 ⟶ 76: [[File:Eclipse_new_debug_configuration.png]] ~~<pre>~~ 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.▼ ▲on the [Arguments] tab: ~~VM arguments: -Xmx128M~~ onNOTE: On newer Eclipse versions, the [Classpath Entries] are under Dependencies tab:. ~~click UserEntries~~ ~~button "Advanced"~~ ~~() add folder \| OK~~ ~~and select the project root folder \| OK~~ ~~</pre>~~ ▲ button [Debug] ▲And then the server should be started. ==To ~~make~~Start ~~the~~Stendhal ~~client~~Client ~~run~~== # Open games.stendhal.client.update.Starter.java in the editor # Then again the small black arrow on the right side of the green bug. ~~(Or you may also choose to use the "Run" command instead of "Debug" in case you only want to debug the server component.)~~ # Select "Debug Configurations" (or "Run Configurations..."). # Select Java Application and click the "New" button in upper-left corner. # On the [Classpath] tab select "User Entries" - button "Advanced" - (*) add folder \| OK - and select the project root folder. \| OK ~~yay shiny new client, shiny server~~ == Making patches == Line 122 ⟶ 100: ==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: # Click the arrow next to either the green "Run" or "Debug" button.