Download the PHP package cunningsoft/achievement-bundle without Composer

Installation

1. Add the following to your composer.json file:

2. Run composer update cunningsoft/achievement-bundle to install the new dependencies.

3. Register the new bundle in your AppKernel.php:

4. Let your user entity implement the Cunningsoft\AchievementBundle\Entity\UserInterface:

5. Map the interface to your user entity in your config.yml:

6. Update your database schema:

7. Import routes:

8. Render the achievement list in your template:

9. Render the "achievement unlocked" layer at the bottom of your template:

10. Import js and css files:

11. Create a child bundle which holds all informations about your achievements

12. Tell twig where to find your assets

Usage

For every achievement you want to use, go through these steps. This is an example showing how to give an achievement for posting a comment with at least 100 characters.

1. Add it to your achievement list

2. Create an event class as a container for the informations about the event

3. Create method to check for the achievement

4. Create achievement image

5. Add achievement description

6. Create event

   
   // src/Acme/MainBundle/Controller/Comment.php
   // ...
   public function create()
   {
       // ...
       $this->get('event_dispatcher')->dispatch('comment_posted', new CommentEvent($comment));
   }
   // ...

Now every time a comment is created (in your business logic) an event is triggered. Because of your achievements.yml the achievement system knows to listen for that event and trigger the according method in your AchievementListener. Now the method in your listener can check whether or not the requirements for one or more achievements are met and if so it triggers the booking of the achievement. Of course you may also utilize existing events or use the events for other purposes as well.

Changelog

• 0.2 (master)

• 0.1 First working version.

Notes

Please also visit my Open Source Browsergame Project Open Soccer Star.