Programming on/with TWCore
Do you want to make bots with TWCore? Do you want to make changes to the core of TWCore? Here is the guide to get you started.
To setup your IDE with TWCore the following steps are described:
- Download Java
- Install Java
- Download Eclipse
- Install Eclipse
- Install Subclipse
- Checkout TWCore
- Resolve compilation problems
- Run TWCore
- Make 4 spaces on a tab
- Committing your changes
Note: This guide describes how to get you started using Eclipse and the Subclipse plugin. These are the recommended programs to use. It's possible that you prefer a different IDE and tools however this guide doesn't describe setting up with these other tools. You're welcome to add another guide though.
Do not be frightened by the length of this guide, most things will go rather quickly.
You need Java Software Development Kit (JDK) for developing TWCore. We currently use Java 7 to run TWCore in Trench Wars. It's recommended that you also use Java 7 for developing so we won't get any problems with java-version-specific features/changes.
Download JDK 7 here: http://www.oracle.com/technetwork/java/javase/downloads/index.html.
Don't choose the java version with netbeans IDE or Java EE, choose the "Java Platform (JDK) XuXX" download.
Installing Java is pretty straightforward; execute the .exe file you downloaded and follow the installation instructions. While Java is being installed, you might want to consider starting the next step, to prevent you from wasting your time.
To download Eclipse go to http://www.eclipse.org/downloads/ and choose the "Eclipse IDE for Java Developers" package.
Once downloaded, extract the 'eclipse' directory from the zip file into
C:\Program Files. (It's recommended to use 7-zip if you need a program to extract zip files.)
Create a shortcut at your desktop or in your start menu to
C:\Program Files\eclipse\eclipse.exe. Please note that it is not mandatory to put Eclipse in your Program Files folder.
When you start Eclipse it will ask you the location of your workspace. You can choose to use the suggested default location but it's recommended to use
C:\Workspaces or equivalent. This workspace is where Eclipse will store all your projects.
NOTE: Due to a bug in Eclipse, it is advised to not name your workspace TWCore. This can lead to problems when you try to run it.
The first time you start eclipse it will display a welcome screen. You can close this screen by closing the Welcome tab or clicking on the silver/gold arrow on the right side of the window.
Install Subclipse plugin
Subversion is the source code versioning system we use for the source files of TWCore. The subversion repository for the source code files is located at this website, under the directory /svn. To prevent you from having to manually download each file one at a time, we will be installing a plugin in Eclipse.
Subclipse is the plugin for Eclipse to work with Subversion repositories. It takes care of checking out, committing, updating, reverting code and much more. It works quite well when you know how to work with Subclipse (and Eclipse). Working with Subclipse is explained in Contributing to TWCore. (You don't need to worry about this yet though.)
There are two main methods as to how you can install a plugin, mainly dependent on the version of Eclipse that you are using.
- On the menu, click on Help / Eclipse Marketplace...;
- In the new window, enter in the search box 'subclipse';
- Press the install button for the Subclipse 1.10.4 as displayed in the image to the right;
- Ensure every box is checked and press the button 'Confirm >'.
If the same screen pops up again, simply press 'Confirm >' again;
- Select the radio button 'I accept the terms of the license agreements' and press the button 'Finish';
- Eclipse will now install the Subclipse plugin. This may take a few minutes.
If any warning boxes pop up, press 'Ok' to continue the installation;
- When finished, a prompt window will be shown asking you to restart Eclipse.
Click the 'Yes' button to restart Eclipse.
- On the menu, click on Help / Software Updates...
- In the new window, click on the tab 'Available Software'
- On the right side of the window, click on the button 'Add Site...'
- Enter the URL
http://subclipse.tigris.org/update_1.8.xand click on OK
- The URL you just entered has been added to the list of websites and automatically expanded.
- Under the URL are 3 components listed; Subclipse, Subclipse integrations and Subclipse SVNKit Option.
Select all checkboxes under the Subclipse component or select the entire Subclipse component.
- On the right side of the window, click the button 'Install...'
- A new window entitled 'Install' will be showed.
- Click 'Next' button
- Select the radiobutton before 'I accept the terms of the license agreements'
- Click 'Finish' button
- Eclipse will now install the Subclipse plugin.
- When finished, a prompt window will be showed asking you to restart Eclipse.
Click the 'Yes' button to restart Eclipse.
Go to the "Subclipse Repository perspective": On the menu, click on Window / Open Perspective / Other... / "SVN Repository Exploring".
Usually you may want to switch perspective using the perspective buttons at the top right of the window:
Note: You will be asked for your username/password when accessing the source repository. The username/password are the same as the credentials of your TWCore.org account. To prevent further prompts for your username and password, make sure to select the checkbox "Save Password".
Follow the following steps to checkout TWCore:
- In the SVN Repository Exploring perspective, right-click on the left area ("SVN Repositories" tab), click New / Repository location...
- In the new window type the following URL:
http://www.twcore.org/svnand press enter or click on "Finish".
- Once the repository has been added, click it open in the left panel by clicking on the [[+]] sign on the left of the URL
- Click on the [[+]] sign on the front of the trunk folder.
- Right click the twcore folder under the trunk folder and click on "Checkout..." in the menu.
- You should see the following window:
- Click on "Finish".
- Eclipse will now checkout TWCore from the Subversion repository.
- Once done, switch back to the Java perspective.
Resolve compilation problems
After checking out TWCore, there will most likely be a few kinds of compilation problems. This chapter describes solving the most common problems (and usually all of the problems).
- If you have the following problems then you haven't set your Java JRE. Please note that the numbers between the square brackets might be different:
- From the Java perspective, right-click the TWCore project and click on "Properties" (last option of the menu)
- In the new window click on "Java Build Path" in the left tree
- Click on the "Libraries" tab
- Select "JRE System Library jdk1.7.0_01" and click on the "Edit..." button on the right
- In the new window click the "Alternate JRE" radio button and click the "Installed JREs..." button on the right
- In the new window you'll see there is no jre1.7.0 in the list, you need to add it.
- Click the "Add..." button
- In the new window click on the "Browse..." button and navigate to the directory where you installed the JDK 7 earlier on (not the JRE directory) and click on OK.
- You'll notice that Eclipse has filled in most of the window. Click on OK again.
- In the "Installed JREs" window you'll see that jdk1.7.0_01 has been added to the list. Click on OK again.
- In the "JRE System Library" window select the jdk1.7.0_01 option from the list of Alternate JREs. Click on the Finish button.
- Click on OK.
You should now see only warnings in the problems tab:
The actual amount of warnings you will see depend on your access level. The public repository currently contains 0 warnings.
If you have the following problems then you only need to refresh and clean your project:
- From the Java perspective, right-click the TWCore project and click on "Refresh".
- In the top menu, click on Project / Clean...
- In the new window, select "Clean all projects" and click on OK.
- The problems should be gone and your problems tab should display something similar to:
Now that you have TWCore compiling successfully from within Eclipse, it's not that hard to get TWCore running from within Eclipse aswell.
Note: you need (access to) a subgame/biller server that run without problems for TWCore to connect to. Bots should be able to enter the server (server.ini setting) or you should have a few bot names that are on vip.txt and sysop.txt . The bots of TWCore need to be sysop since they don't return a security checksum so they can't stay connected without being logged into sysop.
Although optional, it is highly recommended that you also have (access to) a MySQL server for TWCore to connect to. Developers of the TW Bot Dev team can get access to the TWCore test database running on twcore.org.
- From within the Java perspective, lookup setup.example.cfg which is located in the
- Select setup.example.cfg and press Ctrl+C and Ctrl+V to copy the file into the same directory.
- In the popup window enter the name "setup.cfg" and press OK.
Double-click the new setup.cfg file and configure it. Some parameters are described in the Running On Windows guide but it should be self-explanatory.
Notice that you have to set the "Core Location" to the bin directory within your workspace. (For example:
Navigate to the corecfg package (under the src folder)
- Select all the files and press Ctrl+C and Ctrl+V
- Rename each file so that it doesn't have a ".example" part. (Mind that Eclipse puts "Copy of" in front of the filename.)
- Put your own nickname on
sql.cfg. a. For sql.cfg, if you have no access to a MySQL server, you should set the 'ConnectionCount' to 0. All other settings can stay unchanged. b. If you do have a MySQL server set up, then you will need to set up the proper user account(s) and password(s) in here.
Do note that the setting 'ConnectionCount' overrules the amount you've actually specified, and having this count set to a higher number than actual valid connections will lead to the situation where TWCore keeps attempting to connect to a non-existing database.
Now we have to set a single parameter before starting TWCore so that TWCore starts from the
- Navigate to the twcore.core package
- Right-click the Start.java file
- Click on Run As / Open Run Dialog...
- In the Run window double click "Java Application" from the tree left.
- If you see the following error then fix this error first by following the steps below:
- Click on the Arguments tab
- Under "Working directory:" select the "Other" radio button
- Type in:
- Click the Run button
A log tab will now show where you would see that TWCore is starting up; initializing SQL connections and connecting to the subgame server. If something goes wrong it will be displayed in the log window which is usually caused by bad configuration or a problem with the SQL/subgame server.
Project compatibility error
If you have the following error in the Run dialog then follow these steps to solve this:
- If you are still in the Run Dialog, click the Close button to close the window
- From the Java perspective, right-click the TWCore project
- Click on "Properties" (bottom of the menu)
- In the Properties window, click on "Java Compiler" in the tree menu at the left
- Check the checkbox of "Enable project specific settings"
- In the fieldset "JDK Compliance" set "Compiler compliance level" to 7.0
- Click on OK
- If Eclipse asks you to rebuild the project, click on the Yes button.
- To reopen the Run Dialog, click the run button on the toolbar and click on "Open Run Dialog...":
- In the Run window, Click on Java Application / Start from the tree menu at the left
Now you have TWCore compiling and runnable from within Eclipse. You are ready to develop and test your bots!
Make 4 spaces on a tab
We recommend that for TWCore programming the 4 spaces be actual spaces.
You can set Eclipse to use the tab key to make 4 spaces rather than a tab character by doing the following;
- Open your TWCore project in Eclipse
- Go to the menu Project -> Properties
- In the new window click on the [[+]] before "Java Code Style" and select "Formatter"
- Check the checkbox for "Enable project specific settings"
- Create a new profile by clicking the New... button and give it a name. (A built-in profile can't be changed.)
- If necessary, click on the Edit... button to edit the newly created Profile
- On the first tab (Indentation) set "Tab policy:" to "Spaces only"
- Verify that "Indentation size" and "Tab size" is set to 4
- Close the open dialog windows by click on the OK button
Committing your changes
See Contributing to TWCore: Committing/submitting your changes.
Depending on your level of experience, the first time you see TWCore's code, it might all be a bit overwhelming, confusing or simply a maze in general. It is indeed true that various parts of the code are barely documented, and that many gems are well hidden.
To assist you with writing your own bot, or modifying an existing one, we do have several sources that can assist you:
- Bot Creation Tutorial;
- Programming guidelines and a few Tips & Tricks;
- Helpful Developers that you may contact in-game;
- TWCore's JavaDocs.
If you think you've found a problem in our code and want to inform us of it, then please use the 'New Ticket' button at the top of the page to report the issue.