StendhalNetBeans: Difference between revisions

Jump to navigation Jump to search
Content deleted Content added
imported>AntumDeluge
imported>AntumDeluge
 
(144 intermediate revisions by the same user not shown)
Line 4: Line 4:
== Notice ==
== Notice ==
Most of our developers use Eclipse, so using that is recommended, unless you are an experienced Netbeans user.
Most of our developers use Eclipse, so using that is recommended, unless you are an experienced Netbeans user.
<br><span style="color:red; font-weight:bold; font-style:italic;">Incomplete instructions...</span>


== New Project from CVS ==
== Creating a New Project ==

<ol>
<li>Create a new Java project. Go to the menu bar and select "File -> New Project".</li>
<li>In the New Project window Select "Java -> Java Application" and click "Next".</li>
<li>Fill in the following information under "Name and Location":</li>

<pre>
Project Name: stendhal (or whatever you want)
Project Location: Choose the parent directory of your project.
Uncheck "Create Main Class".
</pre>

<li>Click "Finish".
</ol>

== Download Source from CVS ==
<span style="color:blue; font-weight:bold; font-style:italic;">Updated for NetBeans 8.0</span>
<span style="color:blue; font-weight:bold; font-style:italic;">Updated for NetBeans 8.0</span>


<span style="font-style:italic;"><span style="color:red;">NOTE:</span> NetBeans does not come with built-in CVS support. You will need to install the plugin.</span>
<span style="font-weight:bold; font-style:italic;"><span style="color:red;">NOTE:</span> NetBeans does not come with built-in CVS support. You will need to install the plugin.</span>
=== Install CVS Plugin ===
<ol>
<ol>
<li>Go to the menu bar and select "Tools -> Plugins".</li>
<li>Go to the menu bar and select "Tools -> Plugins".</li>
<li>Under the tab "Available Plugins" check "CVS" and click "Install".</li>
<li>Under the tab "Available Plugins" check "CVS" and click "Install".</li>
<li>Restart NetBeans</li>
<li>Restart NetBeans</li>
</ol>
<li>From the menu bar select "Team -> CVS -> Checkout".</li>

=== CVS Checkout ===
<ol>
<li>In the group window under the "Projects" tab select the project.</li>
<li>From the menu bar select "Team -> CVS -> Import into Repository" or right-click the project and select "Versioning -> Import into CVS Repository".</li>
<li>Fill in the following information under "CVS Root":</li>
<li>Fill in the following information under "CVS Root":</li>


<pre>
<pre>
For anonymous checkout:
For anonymous checkout:
CVS Root: :pserver:anonymous@arianne.cvs.sourceforge.net:/cvsroot/arianne
CVS Root: :pserver:anonymous@arianne.cvs.sourceforge.net:/cvsroot/arianne/stendhal
Password: Leave blank.
Password: (leave blank)


For privileged checkout:
For privileged checkout:
CVS Root: :extssh:username@arianne.cvs.sourceforge.net:/cvsroot/arianne
CVS Root: :ext:username@arianne.cvs.sourceforge.net:/cvsroot/arianne/stendhal
Select "Use internal SSH".
Select "Use internal SSH".
Password: Your Sourceforge password.
Password: (your Sourceforge password)
</pre>
</pre>


<li>Click "Next" and fill in the following information under "Module Checkout":</li>
<li>Click "Next".</li>
<li>Fill in the following information under "Folder to Import":</li>


<pre>
<pre>
Folder to Import: (the project's root directory)
Module: stendhal
Import Message: (anything, cannot be left empty)
Branch: HEAD
Repository Folder: stendhal
Local Folder: Path to where you want source downloaded.
Check "Checkout After Import".
</pre>
</pre>


<li>Click "Finish" and checkout will begin.</li>
<li>Click "Finish" to begin import and checkout.</li>
<li>After importing is finished go to the menu bar and select "Team -> Update -> Update" or right-click the project and select "CVS -> Update -> Update".</li>
<li>After checkout completes click "Create Project".</li>
<li>Select "Java -> Java Project with Existing Sources" and click "Next".</li>
</ol>
</ol>


<span style="color:blue; font-weight:bold; font-style:italic;">Skip to section labeled "Setting Up Project".</span>
<p style="font-weight:bold; font-style:italic;">[[ #Configure_Project | Skip to section labelled "Configure Project". ]]</p>


== New Project from Git ==
== Download Source from Git ==
<span style="color:blue; font-weight:bold; font-style:italic;">To be added...</span>
<span style="color:blue; font-weight:bold; font-style:italic;">Incomplete...</span>


<ol>
<li>From the menu bar select "Team -> Git -> Clone".</li>
<li>Fill in the following information:</li>


<span style="font-style:italic;"><span style="color:red;">NOTE:</span> While there are plans to move Stendhal from CVS to Git there is not yet an official Git repository. The following URIs are to testing repository which may not contain updated code. These will change once an official repository is available.</span>
== Setting Up Project ==
<pre>
Anonymous checkout:
Repository: git://git.code.sf.net/p/delugebuilds/stendhal-git

Privileged checkout:
Repository: ssh://username@git.code.sf.net/p/delugebuilds/stendhal-git
Password: Sourceforge password.
</pre>

</ol>

== Configure Project ==


<ol>
<ol>
<li>Fill out the following information under "Name and Location":</li>
<li>Select the project in the "Project" tab of the groups window.</li>
<li>Go to the menu bar and select "File -> Project Properties" or right-click the project and select "Properties.</li>
<li>Select the "Sources" category in the left-hand pane.</li>
<li>Fill in the following information:</li>


<pre>
<pre>
Source Package Folders:
Project Name: stendhal (or whatever you wish)
Package Folder = (the project's root folder)
Project Folder: Path to the root directory of the downloaded Stendhal source code.
Label = (your choice)
Build Script Name: nbbuild.xml (not important, will be deleted)
</pre>
</pre>


<li>Click "Next".</li>
<li>Select the "Libraries" category.</li>
<li>Under "Source Package Folders" add the Stendhal root directory and the "src" sub-directory.</li>
<li>Under the "Compile" tab click "Add JAR/Folder".</li>
<li>Under "Test Package Folders" add the "tests" folder from the Stendhal root directory and click "Next".</li>
<li>Navigate into the "libs" directory of the project's root directory.</li>
<li>If NetBeans warns about a folder containing "compiled class files (*.class)" click "Ignore".</li>
<li>Now click "Finish".</li>
<li>Navigate into the "libs" directory of the Stendhal root directory.</li>
<li>Select all the .jar files and click "Open".</li>
<li>Select all the .jar files and click "Open".</li>
<li>Do the same for the "Processor", "Run", "Compile Tests", and "Run Tests" tabs.
<li>Select the "Run" category.</li>
<li>Under "Configuration" click "New" and add a "Configuration Name" for the server and click "OK".</li>
<li>Fill in the following information:</li>

<pre>
Runtime Platform: Project Platform (should be Java 1.5 or greater)
Main Class: games.stendhal.server.StendhalServer
Arguments: Can be left blank.
Working Directory: Can be left blank.
VM Options: -Xmx128M
</pre>

<li>Again under "Configuration" click "New" and add a "Configuration Name" for the client starter and click "OK".</li>
<li>Fill in the following information:</li>

<pre>
Runtime Platform: Project Platform
Main Class: games.stendhal.client.update.Starter
Arguments: Can be left blank.
Working Directory: Can be left blank.
VM Options: Can be left blank.
</pre>

<li>Click "OK".</li>
<li>Click "OK".</li>
</ol>
</ol>


== Running the Server ==


<ol>
== Configure Project ==
<li>From the menu bar select "Run -> Select Project Configuration -> <server configuration name>" (or select it from the drop-down menu in the tool bar).</li>
<li>From the menu bar select "Run -> Run Project" or click the green arrow in the toolbar.</li>
<li>On the server's first run you will be prompted to set the value of two options, the default database and an RSA key size. The default value for the database is "H2" and for the RSA key size is "512". Place your cursor in the display area of the Output tab in the lower half of the Netbeans window and press "Enter" to select the default values.</li>
</ol>


== Running the Client ==


<ol>
<ol>
<li>Select the project configuration for the client as was done for the Server.</li>
<li>In the root directory (labeled <default package> in the project explorer tab) delete the two new files: manifest.mf and nbbuild.xml.</li>
<li>From the "Projects" tab select the Stendhal project and go to the menu bar and select "File -> Project Properties" (or right-click the project and select "Properties").</li>
<li>From the menu bar select "Run -> Run Project" or click the green arrow in the toolbar.</li>
<li>Select the category "Libraries" and under the "Compile" tab click "Add JAR/Folder".</li>
</ol>
</ol>


= Deprecated Instructions =


== Step 1: Create a NetBeans Project ==
== Step 1: Create a NetBeans Project ==