Update the luma sourcefiles
[xonotic/mediasource.git] / README.txt
1 WHAT NEEDS SOURCE? WHAT IS SOURCE?
2
3 First of all:
4 - "Source", as required by the GPL, is the "preferred form for making
5   modifications" of a file.
6 - Thus, a file that by itself is already the preferred form to edit the file,
7   is considered its own source in the scope of the GPL.
8 - The source of a generated file, however, is typically the input to the
9   generator.
10 - Files that contain the same information, and can be converted without any
11   noticeable loss of information, are equivalent. So if you e.g. made a texture
12   as BMP file and saved it as TGA for the game, clearly the BMP is not
13   required. Also, a HIGH QUALITY JPEG file is usually good enough, as long as
14   it would be good enough for you making modifications to it too.
15 - There is no requirement that the "source files" must be useful for anyone
16   other than you. If they only work on a now-dead computer platform, so be it.
17   If they only work in a really expensive commercial application, so be it.
18   However, they still must be complete (as in, you must not be "hiding" data on
19   your own system - note that this does NOT aim to prevent use of commercial
20   plugins/additions for the software being used), so that the source files plus
21   the parts needed to read it can be turned into the output file again.
22 - Just be honest. You know best what file you use to make modifications, and
23   should simply provide that, whatever it is. We may be unable to verify it
24   fully, but we will reject submissions of which we know that we cannot obtain
25   the complete source.
26
27
28 Specifics:
29
30 models/
31 If you have a file that contains more information than the .smd files the
32 engine can export from the various files, it needs to be provided. Often
33 however, the data in the .smd is already complete and more is not needed.
34 .blend files are always nice though, as Blender can't deal well with .smd
35 files.
36
37 env/
38 Photographed skyboxes need no extra source. Generated skyboxes using 3D
39 software (or Terragen) need the project file.
40
41 gfx/, textures/
42 2D art generally need no extra source as it is perfectly editable on is own,
43 and typically not generated. In case a layered source file (XCF, PSD) exists,
44 providing that would be very nice, though.
45
46 sound/
47 Recorded sound effects generally need no extra source. Generated sound effects
48 need source (the input file for the generator).
49
50 sound/cdtracks/
51 Synthetic music needs some machine readable equivalent to musical score as
52 source. Typically this would be the project file of the application used to
53 create it. Commercial synthesis software may of course be used anyway.
54 Recorded music (using real instruments) needs no source, but musical score in a
55 usable form (e.g. file of a notation application, or if the music was just
56 handwritten, a scan) would be nice.