Finding your way around the Stendhal Web Client Code
- |
Stendhal code design
This doucment describes the code structure of the experimental Stendhal web client. Please see How to setup an experimental Stendhal HTML5 Environment? for information on how to setup a development environment.
Folder structure
The web client is in the srcjs folder, which is next to the src-folder for Java. It makes uses of the marauroa client to handle network communication.
| Folder / Files | Content |
|---|---|
| stendhal/actions.js | Actions sent from the client to the server |
| stendhal/config.js | configuration settings |
| stendhal/data/ | data structures for maps and image caches |
| stendhal/entities/ | entities (a combination of Entities and EntityViews in the java client) |
| stendhal/events.js | events sent from the server to the client |
| stendhal/main.js | main entry point |
| stendhal/ui/ | the userinterface |
User interface
- The world view and the minimap are canvas based
- The draw logic for world view and minimap is inside stendhal/entities.
- The buddy list, chat bar and chat log are rendered using HTML
Entry point
- https://stendhalgame.org/client/stendhal.html is the entry point for the web client.
- On a local development environment the urls are just http://localhost:8080/stendhal.html
- After changes to the javascript files, you need to run
ant compilejs.