Page en Français : Comment contribuer
This page details how to contribute to Flukz.
Flukz is an editor of video games (quite rudimentary yet). It allows anyone, even without programming knowledge, to create new video game levels. Just use the edition mode in the program.
Flukz can process png and jpg images.
If you want to add new graphic themes, we recommend to create first the images in svg format with open softwares like Inkscape and The GIMP, and then to export them in png format.
If you import existing images in Flukz, please take care of the licences, and cite the original author. We accept only GPL or CC-BY-SA licenses. CC-BY-NC-SA or CC-BY-NC-ND are not accepted.
Flukz is able to mix sound and musics in the wave format (.wav files), encoded in PCM at a sample rate of 22050Hz.
If you have a sound file in mp3 format, you need first to convert it in wav, for example with http://www.mpg123.de/index.shtml mpg123:
Then, from a .wav file, you need to convert the sample rate with http://sox.sourceforge.net/Main/HomePage sox:
It is recommended to convert the file with sox, even if the .wav file seems correctely encoded. Files obtained with sox are “standard”, which will avoid most compatibility problems in Flukz.
With sox, you can also extract a part of a file (startTime and timeLength in s):
If you import existing images in Flukz, please take care of the licences, and cite the original author. We accept only GPL, CC-BY or CC-BY-SA licenses.
The licences CC-BY-ND, which forbid remix, are not accepted in Flukz, because sound are remixed when playing games. Also, we don't accept CC-BY-NC licences, which forbid commercial usage, because we consider that it is not clear what is commercial usage and what is not.
Flukz is developed in C++, with the Qt4 library.
The sources of the program are saved in a Subversion repository, that can be accessed at the following address:
svn://svn.tuxfamily.org/svnroot/flukz/flukz/trunk
This anonymous access allows you to obtain the latest development version, but no to “commit”.
You need to install the Qt library on your system in order ot compile. Under Linux, place yourself in the directory containing the flukz.pro file, and execute the followind commands:
qmake make
You obtain a binary file: bin/flukz
Under Windows, open the Qt command prompt, place yourself (with the cd command) in the directory containing the flukz.pro file, and execute the followind commands:
qmake mingw32-make
You obtain a binary file: release\bin\flukz
In case of an occasional contribution on the source code, you can send us an svn patch by mail.
If you want to contribute regularly on the source code, just contact us ! (after creating an account on Tuxfamily, we can give you a direct access to the repository).