Mon, 23 Jan 2012 16:56:34 +0000
changeset 198 6ed8811347fc
parent 197 f5d06a4bfcae
child 215 55f40e0633a6
permissions -rw-r--r--
Updated with some comments from nemo

#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.
  * Finish the doxygen documentation of the QT frontend and the c++ 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 how the map drawing protocol work and how to implement the code for another frontend.
  * 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 know about drowning in any way.

== 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.
  * Create a conversion tool callable by the frontend to convert our demo files to standard video or uploadable files.
  * Write a simple shell script (bash, ruby, perl, python, awk...) to update the localization strings 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.
  * Turn savefiles compatible between iOS and desktop format. This involves getting familiar with engine protocol and keybind interaction.

== GUI improvements ==
  * Don't close room on admin quit if game in progress.
  * Enable private messages in our server.
  * Allow kicking with reason.
  * Expand the drawn maps feature so that all users in the room can draw on a shared canvas at the same time.
  * 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:
  * Notify players about room name change: there should be a new message type added to the protocol. ("ROOM", "RENAME", "oldName", "newname"). A possible implementation could be to pdate the Qt-Frontend that it accepts messages of the format posted below at that it updates the room list; after accepting the message the user interface should reflect the name change. So room list gets updated and if player is in that room s/he'll see a notice message in chat about the room name.
  * Fill every tooltip and what's this text in every button of the frontend with appropriate description strings.
  * 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: fpr example /leave ( = /part  - for leaving room), /quit (disconnects from server), /exit (closes hedgewars), /addFriend, /removeFriend, /ignore, /unignore.
  * When you download something from our DLC page, you usually have to restart the game to load the new contents. Propagate the right signals so that it gets loaded automatically and don't have to restart the game.

== Graphics ==
  * Port our renderer to OpenGL2 / OpenGLES2.0.
  * Make Hedgewars compatible with SDL-1.3: code compiles and launches fine but we have problems for input.
  * Set up a wifi protocol so that tablets can draw maps and send it to the dawn maps of Hedgewars.

== Scripting ==
  * Create a tutorial mission in lua to be included in our training section: this can involve using advanced techniques like portalling or explaining how to play entire game modes.

== 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.
  * Refactor the ammomenu in a sane way, separating the visual and store logic, allowing dynamic size, optimizing for performance, drawing in a single surface.
  * 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).

== 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.
  * Add in-game buttons for touch screen devices.

= 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 ==
  * Prepare a waterfall (eg. ) so that we are able to catch warning and compile failures early on.
  * 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 require a translation: