Stendhal code design

Stendhal code design

• General code design
• Structure of Server
• Structure of Client
• Structure of Web Client

• 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 page gives a little overview about the Stendhal code.

Development Environment

Stendhal is completely open source. So you can download the source code and have a look. If you plan to modify it and contribute to the project, we suggest that you use the Eclipse IDE and checkout the latest development state from our version control system.

There is a good tutorials to get you started with Eclipse.

Finding your way around the Code

The next step is to find your way around the code. The Stendhal code base is roughly devided into the server, client and a little code that is used by both:

• Finding your way around the Stendhal Server Code.
• Finding your way around the Stendhal Client Code.

Stendhal Javadoc

The browsable javadoc is located at http://stendhalgame.org/jenkins/job/stendhal_HEAD/javadoc.

Coding Standards

We try to follow SUN Java code convention, in order to create code that feels familiar to many developers.

Despite this:

• We use tab for all indentation. (One tab is equivalent to 4 spaces for display purpose.)
• We do not stick too closely to line length.

• We always use blocks in if-statements and loops, even if the block only consists of one single statement:

if (condition) {
    method();
}

Avoid evaluation and assignment in the same line like:

• ternary operators, for example in:

 String y = x==null ? "NULL": x.toString();

• post-increment/decrement operators as in:

 if (idx++ == 10) {
   ...
 }