Finding your way around the Stendhal Client Code

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

Are you trying to find your way around the source code of the Stendhal client? Then you should continue reading here as it is going to be explained. This document expects that you have basic knowledge of Java and have already configured your Development Environment.

So, you can find the main client code in the package games.stendhal.client and some more dependencies in games.stendhal.common.

Packages

So lets have a look at the packages in games.stendhal.client:

package name	purpose
actions	actions triggered on the client (most of them are sent to the server for processing).
entity	everything you can interact with in game (players, monsters, items, portals, ...)
events	events are sent from the server to the client
gui	the user interface including all dialogs, the main game window and views for the game entities.
sound	sound and music
sprite	handling of images for world objects and the user interface
update	the automatic software updater