b3dgs / lionengine

Java 2D Game Engine

B3DGS Parent

lionengine's Issues

Improve Unit Test Coverage

Improve the unit test coverage.
Try to reach at least 80% for each module (especially the core).

Create lionengine-audio module for each audio type

Create a lionengine-audio module for each supported type:

• lionengine-audio-wav
• lionengine-audio-midi
• lionenigne-audio-sc68

This will avoid code duplication between lionengine-core-awt and lionengine-core-swt.

Add a quick access view for the supported types (map, factory...)

Currently the user have to search by himself the right class.
Having a view containing only the supported types will improve the user's access time and the readability.

Mavenize remaining projects

Some project are not using maven (only the core part is using it). Add the remaining pom files for these projects.

Set the core package to public visibility and allow custom implementation

In order to make it compatible with OSGI (as default package visibility are not accessible), update the core package to public in order to make it compatible.

Create an integrated tile collision editor for an easy definition of them

Tile collision implementation can only be done from code.
The current way of implementing it is not really complex, but it may be hard to implements more complex collisions (such as link between ground & slope), and also harder to debug it (impossible to show them).

The goal is to allow an easier tile collision definition directly from the collisions.xml file, such as the following examples (tile size = 16, so min=0 & max=15):

• Simple example

<collision name="GROUND">
    <tiles pattern="4" start="1" end="100"/>
    <function description="ground" y="0">
        <x min="0" max="15"/>
    </function>
</collision>

• y is the returned collision vertical point
• min & max are the function range for the horizontal location (where it can be applied)
  Here we defined a ground collision for the complete surface (from 0 to 15), and the return vertical location is at the bottom of the tile (0).

• More complex example

<collision name="SLOPE_TRANSITION">
    <tiles pattern="4" start="1" end="100"/>
    <function description="ground" y="0">
        <x min="0" max="7"/>
    </function>
    <function description="slope" y="-x/2+8">
        <x min="8" max="15"/>
    </function>
</collision>

• y is the returned collision vertical point, by considering x as the horizontal location on the tile)
• Here we defined a complex slope collision:
  • The first half size of the tile is a ground collision at the bottom
  • The last half size of the tile is a slope collision, starting perfectly after the ground one (+8, were the ground ended at 7)

Considering this, it should be easy to display an integrated debug mode for the collisions (by displaying the corresponding function after the map rendering).

It would also be nice to have a visual editor of this function, by using a simple map tile editor, that should be able to import a level rip (already available), define & assign collisions for the desired tiles by clicking on them.

Try to use Android 1.5 as a minimum version instead of 2.3.3

In order to increase the overall compatibility with any platform, try to use Android API 3 instead of API 10.

Rename lionengine-game-rts to lionengine-game-strategy

The name "rts" is now incorrect, so that "strategy" must be used instead.

Repair f_network package

Due to engine update, the f_network package is still not up to date.

Use directly class reference for object creation instead of enum

In order to solve an unchecked cast, try to not use the enum for object creation, but directly its class type reference.

bba

Rename lionengine-java2d to lionengine-core-awt

The module lionengine-java2d should be renamed to lionengine-core-awt as it is more relevant to the implementation usage.

EntityGame should be renderable

Add to the abstract a render method.

Update projects POM and create a parent project

Add a parent project, and update all other POM.

Instead of including JNA in dist, just mark it as provided by the user in order to be more flexible and reduce distribution size (and also duplication).

Android support

Analyse and try to add a support to android.
New module lionengine-android should be created, as lionengine-java.

Add a project concept

As the editor will support many map implementation (standard, platform, strategy...), their instance have to be dynamic, without having to modify the editor code manually.

So instead of just retrieve the resources folder, it should be better to add a project handler feature, which will also contains the resources folder.

Once a project is opened, it should be possible to select a map implementation (by searching its class from a dialog) and pass it to the editor in order to use it.
A first constraint sounds to be the map constructor, which must be simply the default one.

Do not focus on multi-projects handling.

What should be done:

• Set the resources explorer view as a projects view
• Define a project class and its properties
• Create a new project dialog & wizard (allow to create a project from scratch)
• Allow to open an existing project (just read the project properties and put it in the projects list)
• Allow to import an existing project which is not a lionengine project (just add the properties file and tag it as a lionengine project, open it and put it in the projects list)
• Put a message in the world view if no map implementation is selected
• Allow to select a map implementation from the project tree

Create the editor project base

Create a new project outside the engine core parts, called lionengine-editor, by using RCP4. Setup the program base with an initial view that will be completed later.

Allow to view a level from the editor on the WorldView, and navigate on it by using a grid

Include a level editor, with a grid depending on the tile size, and a navigation by using the keyboard (first, maybe other things later).

This step is about preview only, no tile editing or something else.

Lionheart Demo

Prepare a Lionheart Demo that will use as much as possible the engine.
Items:

• Gameplay (movements, attacks, collisions)
• Collisions (full at least for swamp level)
• Monsters & Objects
• Background
• Level Editor

Link the lionengine-editor to lionengine-core-swt

In order to prepare game rendering inside the editor, ensure it is possible to start the engine from within it.

Integrate XML editors with the associated XSD for the element edition

Create an XSD per category (collision, entity...) and an integrated XML editor in order to edit with ease any parameter manually without forget anything.

It should also be possible to add elements from the project view, as:

• Entities folder type (for entities folder)
• Entity data
• Patterns list (for tilesheets folder)

Dedicated editor for:

• Entity animations
• Entity collisions
• Tile collisions

Move existing unit tests to their dedicated project

Currently there is one single project dedicated to unit test, because an engine implementation was required to make it work.

Since there is more than one engine implementation (AWT, SWT & Android), the best would be to reintegrate the tests inside each of these modules.

As a first step, just move the existing tests to their module owner.

Merge MapTilePlatform with MapTileGame

In order to give access to advanced tile collision to any type of map, merge the MapTilePlatform with MapTileGame.
It should be fully compatible, as there is nothing specific in Platform side.

Review sequence architecture in order to solve the render thread problem

Currently, there is one thread per sequence, plus the loader.
With some libraries such as SWT it will be a problem.
The idea is to change the way on how it is working in order to keep one single thread for the rendering.

It will also be the opportunity to update the input factory (mouse, keyboard...) in order to make it compatible with any system (PC, Android...).

Audio system can also be reviewed in order to allow platform specific (such as midi).

Create two maven profiles (core & extra)

In order to separate properly the compilation phases, create two profiles

• core for the main lionengine projects
• extra for the additional projects

Allow multiple call to MapTileGame#loadPatterns

MapTileGame#loadPatterns is locked to a single call for each map instance. In case of a map reload with a new theme, it was not possible to apply it.

Review general lionengine-core code

Due to the many recent updates and improvement, review all the code, and check, according to the test, if it is possible to improve something.

Update also if necessary the javadoc.

Allow to define tile collision even for non consecutive tiles

Currently the only way to define tile collision is to group them sequentially by collision.
The goal is to remove this constraint by enabling individual assignment or by range.

Example:

• Before

<?xml version="1.0" encoding="UTF-8"?>
<collisions>
    <collision name="GROUND" pattern="0" start="1" end="1"/>
    <collision name="BLOCK" pattern="0" start="2" end="2"/>
    <collision name="TUBE" pattern="0" start="3" end="4"/>
    <collision name="WALL" pattern="0" start="5" end="6"/>
</collisions>

• After

<collisions>
    <collision name="GROUND">
        <tile pattern="0" number="1"/>
    </collision>

    <collision name="BLOCK">
        <tile pattern="0" number="2"/>
    </collision>

    <collision name="TUBE">
        <tile pattern="0" number="3"/>
        <tile pattern="0" number="4"/>
    </collision>

    <collision name="WALL">
        <tiles pattern="0" start="5" end="6"/>
    </collision>
</collisions>

• <tile pattern="0" number="1"/> allows to define a single tile collision
• <tiles pattern="0" start="5" end="6"/> allows to define a multiple tile collision by range

Allow to control objects on the loaded level

Once the level can be previewed inside the world view, objects can be placed, by selecting them from the resources selection (the XML represents the object).

It should also be possible to remove placed objects, and move them by using the mouse.

About the objects organization, it should be possible to sort them in any way (race, category, theme...).

Documentation

Finalize documentation in many format:

• Presentation (PDF)
• Javadoc (HTML)
• UML Diagram (PNG)

Try to use SWT 3.5.1 as a minimum version instead of 4.3

In order to increase the overall compatibility with any platform, try to use SWT 3.5.1 instead of 4.3.

Integrate external doc to javadoc (class level)

Instead of using an external doc system (such as a wiki which is complex to maintain), it would be better to include all that doc into the javadoc itself (class level documentation).
This way it will be easy to generate and navigate trough the javadoc.

Update project to Maven

Support maven.
Create pom file, update projects organizations.

Rename lionengine-android to lionengine-core-android

The module lionengine-android should be renamed to lionengine-core-android as it is more relevant to the implementation usage.

Change licence to LGPL for the core part, keep GPL for extra

Use LGPL licence for the standard LionEngine library:

• lionengine-core
• lionengine-core-awt
• lionengine-core-swt
• lionengine-core-android
• lionengine-audio-wav
• lionengine-audio-midi
• lionengine-audio-sc68
• lionengine-network
• lionengine-game
• lionengine-game-platform
• lionengine-game-pathfinding
• lionengine-game-strategy
• lionengine-examples
• lionengine-tutorials

Keep GPL for tools and applications:

• lionengine-editor

Add some default checkstyle rules, and fix them if possible

Use some default checkstyle rules, check code and fix them when possible.

Fix pong AI racket movement

The rack AI is not moving (timer problem).

Create lionengine-core-swt module

Add a new module called lionengine-core-swt as a core implementation in order to support SWT rendering.

Add support of plugin for the main lionengine modules

Main engine modules should be compatible with an OSGI environement in order to include them in the editor.

Complete lionengine-examples

Add enough examples to make the engine easily understandable.

• Full lionengine-game module
• Full lionengine-game-platform module
• Full lionengine-game-rts module
• Full lionengine-game-network module

Examples should be simple, by just showing what is necessary.

lionengine-editor : in pom.xml maven error

I encountered a problem, do not know how to do?
lionengine-editor project： in pom.xml node error info:
"Plugin execution not covered by lifecycle configuration: org.eclipse.tycho:tycho-compiler-plugin:0.20.0:compile (execution: default-compile, phase: compile)"

Tutorials

Add a least one progressive tutorial, showing how to make a game prototype.

Create a new module for that: lionengine-tutorials

Warcraft Demo

Prepare and update the Warcraft Demo by using as much as possible the Rts module.
Pathfinding need also to be improved (group movement).

Tyrian Demo

Prepare a Tyrian Demo and complete the shmup examples.

Projectiles usage should be demonstrated.

Fix Findbugs problems and ignore false positive

Fix all problems reported by findbugs, and create an ignore list for the false positive.

Fix collision for platform module

A problem in collision detection may occur if vertical translation is too fast.

Use directly class reference to get input device instead of enum

In order to solve an unchecked cast exception, use the target class directly as argument instead of its enum type with a non typed class target.

Rename Utility classes to Util

In order to reduce space used by the utility classes, rename them to a shorter name.

Merge Click & Key class with their associated device implementation

Instead of using one interface for constants click & key value, put them inside the corresponding device implementation (Mouse & Keyboard) for the required core modules.

Create a dedicated geometry package

Instead of mixing geometry component with the code, try to put them in a separated package in order to narrow the core functional field.

Known classes:

• UtilityMath
• LineImpl
• PolygonImpl
• RectangleImpl

plus their interfaces