Wed, 26 Sep 2012 15:40:03 +0000
changeset 251 103e54e77c6f
parent 216 6f7c0c72bd12
child 303 b281fa4ed31f
permissions -rw-r--r--
Removed some entries which got implemented, fix some typos

#summary Where to find possible task, todos, fixmes and new ideas.
#labels Featured,Phase-Requirements,Phase-Design,Phase-Implementation,Phase-QA,Phase-Support

= Introduction =

Welcome! If you are reading this page you might be wondering how you can help the Hedgewars project! Fear no more, we've set up a good list of ideas that you might tackle while getting to know the sources!

As always, we'll be glad to help you in this quest! Just join our IRC channel and ask the devs directly! The possible ideas are divided by category and some might be easier than others: just pick the one you feel most confident with.

= Documentation =

== Doxygen ==

  * Add doxygen documentation to server for the haskell sources.
  * Add doxygen documentation to ios frontend for the objc sources.
  * Add doxygen documentation to engine for the freepascal sources.
  * Add doxygen documentation to android port for the java sources.

== Various ==

  * Document the interaction of engine/frontend/server network protocol
  * Document how the engine launches a game, from setting up the window, to updating the opengl renderer, from loading up contents, to cleaning up memory.
  * Document the format of the demo and save files.

= Code =

== AI ==
  * Make our AI use of the rope weapon to move and reach better positioning before firing.
  * Make our AI use any weapon of your choice.

== Tools ==
  * Refactor the frontend networking layer into library calls from hwengine, in a similar fashion to what's done on iOS and Android, using QT framebuffers.
  * Write a simple shell script (bash, ruby, perl, python, awk...) to update the localization strings for iOS and propagate the diff to all the localized files. This task doesn't require coding or having an i-Device, just basic shell scripting.
  * Create an easy-to-use theme editor, outlining all the necessary files for our themes.
  * Make a cross-platform tool (for instance a script) that identifies new phrases in our mission, traning and gameplay scripts and adds them (marked untranslated) into our lua locaization files.
  * Update and document the command line arguments parsing.
  * Implement an handicap system allowing for increased difficulty on some teams instead of on the whole match.

== GUI improvements ==
  * Enable private messages in our server.
  * Allow kicking with reason.
  * Modify the drawn maps feature so that users can see a preview of what the admin is drawing.
  * Rework the hat selection for hogs.
  * Make the preferences that are modifiable from engine (eg. volume) update the ones specified in the frontend, using a new network message.
  * Rework the draw-map functions, adding different brush sizes, brush types and something new.
  * Drop a shadow effect to every widget in our frontend. This will help you:
  * Rework the game map section (eg. instead of using a dropdown menu, use standard push buttons).
  * Create an advanced settings page, where to specify different screen resolution for windowed and fullscreen mode, different audio preferences, different quality configuration and so on.
  * Enable some commands while in frontend: for example /leave ( = /part  - for leaving room), /quit (disconnects from server), /exit (closes hedgewars), /addFriend, /removeFriend, /ignore, /unignore.

== Graphics ==
  * Make Hedgewars compatible with SDL-1.3: code compiles and launches fine but we have problems for input, due to the frontend/engine interaction.
  * Set up a wifi protocol so that tablets can draw maps and send it to the drawn maps of Hedgewars.

== Engine ==
  * Make hedgehogs without a hat get special hats if there currently is a special occasion such as Christmas.
  * Implement construction mode; this page contains a general description of what we mean but you are allowed to improve or modify our concept.

  * Allow participants in a game to view weapon sets and schemes before starting the game. This task could be carried out by showing an overlay window when mouse is over the scheme or weapon entries.
  * Change the loading screen to show participating teams/players (and maybe even all the hogs if space is available
  * Add the ability for themes to have stars high above the ground (comparable to clouds).
  * Perform some engine cleanup, expecially in file loading, image flag handling and various TODOs and FIXMEs.
  * Implement a better, faster land generation: for more details, visit
  * Sometimes you exit the game for a mistake and that's sad! Add a quick resume button to the game configuration for both local and network games.
  * Enable some commands while in engine chat, for example /quit to exit (you may want to just stop the game brutally with chForceQuit), /fullscreen to set the max window dimensions, /pause to pause the game, /bind for binding keys, /finish which would just have the game end by teleporting all hedgehogs out, then showing statistics (see chFinish).
  * Allow for flipped maps.

== Mobile == 
  * Implement preferences/options in the Android port, basically allow the existing preferences options from the desktop version to the port using Android shared preferences.

= Q/A =

== Testing framework ==
  * Add an expandable testing module so that we can trigger main server functions and check their return values.
  * Add an expandable testing module so that we can trigger main frontend functions and check their return values.
  * Add an expandable testing module so that we can trigger main engine functions and check their return values.

== Other tests ==
  * Run valgrind on engine, report the leaderboard of most used functions and optimise them so that performance increases.
  * Unify the translation files in something more usable, reducing the number of files and the repeated phrases.

= Translation =

Pick a language of your choise! There is certainly need of an update or a revision or even a completely new language.

Here is the list of english files that contain a translation; be sure to check whether some work has been done, either by reading the file or by checking the same file with your language code instead of the English one:


= Contact =

The best way to get in touch with the devs is to join our IRC on Freenode (#hedgewars) and to interact with everyone there. Please be patient as not always there are dicussions going on there.