This repository was archived by the owner on Dec 20, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Code Style
Ángel Serrano edited this page Apr 3, 2014
·
2 revisions
All Java files in the code are formatted using a Eclipse formatter and headed with the eAdventure license. You can forget about it while coding, and when everything is ready, you can execute the following in the project root:
mvn clean install
This will automatically format the code and add the license header (and will also ensure that your contribution passes the automatic testing).
In general, the eclipse-formatter will keep things clean. However, if you still have some doubts, try to be consistent with the rest of the code.
However, as last resource, we mostly follow the Google Java Style Guide.
eAdventure - eUCM research group
- Setting up a Development Environment
- Contributing Guidelines
- Build Process
- Project structure
- Schema
-
Engine
- Files paths and FileResolver
- Binding Schema elements with Engine elements
- Managing the game view through Layers
- Game loop and scene management
- IO
- File Resolver
- Assets: Converting schema objects to engine objects
- Engine Objects
- Actors
- Effects
- Testing the engine
- Editor
- Remote communication
- Release Process
- Other documentation