• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..07-May-2022-

COPYING_GPL3H A D04-May-201134.3 KiB675553

GPL_VERSIONSH A D04-May-20111.4 KiB2821

INSTALLH A D04-May-201118.3 KiB461338

Makefile.amH A D17-Apr-2011214 149

Makefile.inH A D04-May-201112.5 KiB446380

OFLH A D17-Apr-20114.5 KiB9879

READMEH A D04-May-201132.1 KiB849633

README_DATA_LICENSESH A D04-May-20113.8 KiB7769

TODOH A D04-May-20113.3 KiB9671

changelogH A D04-May-201153.4 KiB1,5121,164

README

1"Tux, of Math Command" - an educational math tutorial game starring Tux,
2the Linux Penguin
3-----------------------------------------------------------------
4
5May 04, 2011
6
7For Tuxmath-2.0.3
8
9Objective ---------
10
11In "Tux, of Math Command," you play the part of Commander Tux, as he
12defends his friends from an attack of math equations. Comets are
13crashing towards the friendly penguins in their igloos, and you must
14destroy the comets by solving their equations.
15
16As of version 1.7.0, TuxMath also includes a completely new game
17activity, "Factoroids", which gives practice in factoring numbers and
18simplifying fractions, as well as zapping rocks floating through
19space.
20
21
22Installation
23------------
24
25For instructions on installing the game on your system, please read
26the "INSTALL.txt" file.
27
28
29Configuration
30-------------
31
32If multiple players are using a single account (e.g., a home computer
33that is always logged in, or a school setting in which all students
34have a single username), you may want to do some additional
35configuration---see below under "Configuring Multiple Users."
36
37
38Running The Program
39-------------------
40
41(Linux/Unix)
42------------
43
44Your distribution probably already has a
45menu entry for Tuxmath under the KDE or GNOME menus.  If not,
46depending on your graphical interface or window manager, you can
47probably also create a clickable icon which will launch the game.  See
48your interface's documentation or help screens for details.
49
50Alternatively, simply type the command "tuxmath" at a command prompt
51(eg, in an xterm). Many command-line options are supported, e.g
52"tuxmath -f" for fullscreen or "tuxmath -w" to run in a window.
53
54(Windows)
55---------
56
57Just double-click the "TuxMath.exe" icon or select "Tuxmath" in the
58Start Menu.  The current installer creates menu items to run tuxmath
59either in Fullscreen mode or within a 640 x 480 window.
60
61Mac OSX
62-------
63
64Double-click the "tuxmath" icon.
65
66
67
68Program Navigation
69------------------
70
71Use the [UP] and [DOWN] arrow keys to select what you wish to do, and
72then press [ENTER / RETURN / SPACEBAR].  You can also type 'J' to move
73down or 'K' to move up, for those accustomed to certain text editors
74;). You can also use the mouse to click the menu item.
75
76Pressing [ESCAPE] will "go back" one level in the menus, or quit the program if
77pressed at the top level.
78
79Title Screen
80------------
81
82Play Alone: single player activities:
83-----------
84
85Math Command Training Academy: choose this to go to a list of over
86fifty prepared lessons, starting with simple typing of single digit
87numbers, and progressing to multiplication and division involving
88negatives and "missing number" questions (e.g. "-17 x ? = 119").  The
89player wins if the question list is completed successfully.
90Successfully completed lessons are indicated with a flashing gold
91star. From a math drill standpoint, the best way for teachers or
92parents to use TuxMath is to have kids work their way through all the
93lessons until all of the gold stars are obtained.
94
95Math Command Fleet Missions: choose this to be given a series of
96progressively more advanced missions tied together by a fun story
97line. The fate of the galaxy is in your hands!
98
99Play Arcade Game: use this to select from one of five open-ended,
100"Arcade Style" games, meaning the game play gets faster and faster as
101long as the player can keep up, with the goal being to get the highest
102score possible.  The options include:
103
104	Space Cadet - simple addition.
105
106	Scout - addition and subtraction to ten.
107
108	Ranger - addition, subtraction, multiplication, and
109	division to ten.
110
111	Ace - all four operations with operands to 20, including
112	negative numbers and "missing number" type questions.
113
114        Commando - all of above plus multiple operands - e.g. -3 x ? + 14 = 2
115
116If you make one of the top ten scores for the difficulty level, you
117get to enter your name in the TuxMath Hall of Fame!
118
119Play Custom Game: use this to play a game based on the config file in
120the player's home directory (see below). At some point, the options
121will be settable from within the game.
122
123Network Game:
124------------------
125
126Tuxmath now provides head-to-head competition over a local area network! All
127players see the same questions, and whoever answers first gets the points for
128that question. The game play is cooperative, however, in that all participating
129players help defend all the igloos.  Up to 16 players can participate in a
130single game (this can be increased extremely simply with a recompilation, if
131desired).
132
133To set up network play, the tuxmath server program needs to be started. Simply
134go to Network Game->Run Server and follow the directions. You just need to type
135in a name to identify the server to players (such as "Tux Server").  If we are
136able to use threads on your platform, you will also be prompted to pick the
137lesson file to be used by the server.
138
139Once the server is running, players can connect by going to Network Game->Join
140Game.  TuxMath should automatically detect the server if it is running on the
141local network.  The player will be asked to enter a nickname, then click an
142arrow to indicate that he/she is ready to start.  A list of currently connected
143players is displayed during this process. When all players have indicated that
144they are ready, the game will start.
145
146Note that while network play is functional, it needs more testing, and some
147aspects have not yet been addressed:
148
149- While a network game is in progress, do not play a non-network game
150  on the same computer - this will also confuse TuxMath (because
151  TuxMath is not yet "thread-safe").  However, it is fine to participate
152  in the network game from that computer.  Also, don't quit the program
153  with the server while others are still playing a network game!
154
155- It is also possible to run the server as a separate program on Linux
156  platforms by typing "tuxmathserver" at the command line.  This
157  avoids any issues with thread-safety, but for now the server will only
158  use the default question list settings if launched this way.
159
160
161Play With Friends:
162------------------
163
164Compete with your friends by playing in a turns-based fashion! The math
165difficulty levels are the same as for the "Arcade" games. Note that this
166involves rotating play at a single computer rather than network play, as
167described above.
168
169Factoroids!
170-----------
171
172As of version 2.0.0, the Factoroids game has been extensively revised to make
173it much more fun (and less cumbersome) to play, and hopefully more educational
174as well.  Now, Tux's ship is equipped with a set of six "Prime Number Guns",
175for the numbers 2, 3, 5, 7, 11, and 13.
176
177In the first wave, Tux only has the 2 Gun, and all of the asteroids are powers
178of 2.  For the second wave, the 3 Gun is added, so the targets are powers of 2,
179powers of 3, or their multiples.  Another Prime Gun is added with each wave.
180
181Factoroids now supports mouse control of Tux's ship:
182    - lateral mouse movement rotates ship.
183    - left mouse button: fire
184    - right mouse button: thrust
185    - scroll up/down: change Prime Number Gun
186
187As before, the ship can also be steered with the arrow keys.  The weapon can be
188cycled in either direction with the [D] and [F] keys, and fired with [Space].
189
190Factoroids now has three different powerups:
191    - Shields: allows ship to smash through rocks like a battering ram for ten
192      seconds
193    - Stealth: allows ship to pass through rocks unharmed
194    - Smart Bomb: simultaneously zaps all rocks with the currently selected
195      Prime Number Gun.
196
197One powerup is awarded at the successful completion of each wave.  It can be
198activated by pressing [Shift].  You can have only one powerup at a time -
199unused powerups are lost.
200
201
202
203Help: this offers a short tutorial to teach game play for the main comet game.
204----
205
206More Options:
207-------------
208
209This will be developed into the menus to set options not directly
210related to math questions, such as toggling the music on and off,
211playing fullscreen vs. windowed, using cities vs. igloos, and the
212like.  Now it just has the "Demo" mode, as well as credits and project
213information.
214
215
216
217How To Play
218-----------
219
220One of the best ways to get started is by choosing the "Help" option
221in the main menu.  This offers a tutorial for basic play.  There are
222some additional features described below.
223
224Destroying Comets
225-----------------
226
227As the comets fall towards your friends, you must solve the equations.
228
229To destroy it:
230--------------
231
232First, figure out the answer to the equation.  For example, "3 x 4 =
233?" would be "12"
234
235Second, type in the answer.  As you type numbers on the keyboard, they
236will appear in the "LED"-style display on Tux's flat-panel monitor.
237If negative answers are enabled, there will be a fourth place in the
238LED display for the minus sign.  The '-' and '+' keys will toggle the
239minus sign on and off, respectively.
240
241Finally, press [ENTER / RETURN] or [SPACE].
242
243
244The comet that has the number you entered as its answer will be shot
245down by Tux!
246
247Note: Sometimes more than one comet will have the same answer.  In
248this case, all the comets having the answer will get destroyed.
249
250Note: After typing [ENTER / RETURN], the "LED"-style display will
251automatically reset to "000" for you, so you can answer the next
252equation!
253
254
255Correcting Your Answer
256----------------------
257
258If you made a mistake as you typed in your answer, you can press
259[BACKSPACE / DELETE] and the "LED"-style display at the top center of
260the screen will reset to "000".
261
262
263Using the On-Screen Keypad
264--------------------------
265
266If you launched the program with the "--keypad" (or "-k") option, the
267game screen will also have a numeric keypad on the center of the
268screen.  (It has a similar layout to most keyboard number pads and
269calculators.)
270
271Using the mouse pointer to click on the on-screen buttons acts just
272like typing numbers on the keyboard.
273
274This feature could be useful for computers with touchscreens, or for
275players who cannot use a keyboard.
276
277
278Advancing Waves
279---------------
280
281When all the comets are destroyed for one wave, the player advances to
282the next.  The level of difficulty generally increases with each
283level.  On Training Academy lessons, the program "learns" from the
284player to try to adjust the difficulty, and may decrease if the player
285has lost one or more igloos (see below).
286
287
288Losing An Igloo or City
289-----------------------
290
291The default setting is to play with igloo-dwelling penguins.  If a
292comet reaches the igloo, the igloo is partially melted.  A second hit
293melts the igloo the rest of the way, and the saddened penguin trudges
294off the screen.
295
296If cities are used (by placing "use_igloos = 0" in the config file and
297selecting "Play Custom Game"), game play is the same.  The first comet
298strike deactivates the city's shields, and the second hit destroys the
299city. If this seems too scary or violent, please use the penguin/igloo
300theme!
301
302
303Regaining Igloos/Cities
304-----------------------
305
306When a question is answered correctly, the player earns progress
307toward a bonus comet that allows an igloo or city to be rebuilt.
308Progress is indicated with a green bar in the upper left corner of the
309screen. The bonus comet is red and moves faster than regular comets.
310If the player shoots down the bonus comet, a "snowstorm" image appears
311in place of the bonus progress bar, and one of the igloos/cities will
312be rebuilt after the current wave.
313
314
315Earning "Smart Bomb" Powerup
316----------------------------
317
318In the "Arcade" games, there will occasionally be special yellow comets
319that fly rapidly across the screen in a horizontal direction.  You have
320to be quick to shoot them (and they are admittedly a little hard to
321read), but they earn you a powerful weapon that can zap all the comets
322on the screen.  The "smart bombs" can only be used once (until another
323one is earned), so use them wisely.
324
325Ending The Game
326---------------
327
328The default mode is now to play through a defined list of questions.
329This mode is used in the "Training Academy" games.  For "Custom"
330games, it can be selected by setting the config file
331'play_through_list' parameter to 1 ('yes' or 'true'), or via the
332"--playthroughlist" command line argument.  The list is generated by
333TuxMath based on a series of selectable parameters (selected math
334operations, number ranges, etc). By default, the questions are asked
335in a random order.  If answered correctly, they are removed.  A
336question that is not answered correctly (allowing the comet to destroy
337its target) will reappear in random order.  If all questions are
338successfully answered before the igloos or cities have been destroyed,
339the player wins and a "victory" screen is displayed.
340
341Arcade-style play is also supported, in which the game continues until
342you lose all of your igloos or cities.  A GAME OVER screen is then
343displayed.  If you use one of the standard Arcade games, you'll have
344the opportunity to put your name in a high-score table.  For the
345"Custom" games, you can select this mode by setting
346'play_through_list' to '0' ('no', 'false', 'off').
347
348By pressing Esc or clicking on the red circle in the upper right
349corner, you can quit the game.
350
351Shortcut Keys
352-------------
353
354The following shortcuts are supported during game play:
355
356      [F10]:        switches between windowed and full-screen display mode.
357      [P] or [Tab]: pauses the game, if allowed. The included "Math Command
358                    Training Academy" lessons allow pausing, while the "Arcade"
359                    games do not.
360      [Up Arrow]:   increase speed by 20%, if allowed.
361      [Down Arrow]  decrease speed by 20%, if allowed.  Speed changes
362                    are allowed when pausing is enabled.
363      [Esc]:        leave current game and display the menu.
364      [Shift]:      (Arcade game only) - activate "Smart Bomb" to zap
365                    everything on the screen.  This can only be used once,
366                    until you earn another one by zapping another yellow
367                    "powerup" comet.
368
369
370Setting Game Options
371--------------------
372
373The "Options" system remains in need of an overhaul. For now, you can
374play the pre-packaged "Lesson" or "Arcade" games, or edit the options
375file to create a "Custom" game.  At some point the "Custom" settings
376will be modifiable from within TuxMath.
377
3781. The program reads and writes the settings to disk in a
379human-readable fashion, where they can be modified with a text editor.
380The file contains extensive comments describing all settings. By
381editing and saving this file, very extensive control over the program
382is supported, particularly with respect to generation of math
383questions. There really is no need to use command-line options any
384more.
385
386On Unix/Linux (non-Mac): the file is created in the user's home
387directory within a directory called ".tuxmath" and is simply called
388"options". As an example, a user "laura" on a Unix/Linux system would
389find this at /home/laura/.tuxmath/options.
390
391On Macs: the file can be found under tuxmath/Contents/Resources.
392
393On a Windows XP or Windows 2000 system, the config file is called
394"options.txt" and is located at C:\Documents And
395Settings\USER\Application Data\TuxMath\options.txt, where USER is the
396login of the current user. Note that 'Application Data' is hidden by
397default by the operating system.
398
3992. Many command-line options are supported (see below).
400
401
402Setting Administrative Options
403------------------------------
404
405"Tux, of Math Command" allows parents/teachers to control whether the
406game options can be changed by the player.
407
408The game options are first read from a master config file in the
409program's data directory (/usr/local/share/tuxmath/missions/options on
410*nix if installed using "make install"), then overridden by the user's
411own /.tuxmath/options file if "per_user_config" is selected in the
412master options file.  If "per_user_config" is deselected, the game
413starts up with the master settings.  (This is somewhat under
414construction).
415
416
417Game Summary Files: Tracking Players' Performance
418-------------------------------------------------
419
420"Tux, of Math Command" saves summaries of the last ten games in the
421player's .tuxmath directory.  The files are named "summary1" through
422"summary10", with "summary1" the most recent. The files includes lists
423of questions asked and questions missed, along with the numbers of
424correct and incorrect answers and the percent correct and information
425about how long a given question was typically displayed on the screen
426before it was answered.
427
428In addition to these summary files, there is also a log.csv file that
429contains a one-line summary of each attempted mission (the user must
430have answered at least one question to count as an attempt).  This
431file can be imported into a spreadsheet program (OpenOffice.org calc,
432Microsoft Excel, KSpread, Gnumeric, Google Docs, etc.) to examine or
433chart child progress.
434
435
436Using Multi-User Configuration: Some Tips for Teachers
437------------------------------------------------------
438
439Your school's computer administrator can configure TuxMath so that
440students "log in" when they first start playing (see below).  Students
441will then have their own personalized gold star records, and summary
442and log files (described immediately above) will be saved for each
443student individually.
444
445If you want to test TuxMath yourself without "contaminating" the
446records in a student account, hold down the control key ("Ctrl") when
447you click on the menu entry corresponding to you and your classroom.
448Then you will be playing "as yourself."
449
450
451Configuring Multiple Users
452--------------------------
453
454In some cases, the user's log-in name is not very informative: an
455example is when schools use a single username "student" for all
456students in the school.  It is possible to set up TuxMath so that it
457asks students to "log in" (without any password) when they first start
458the game.  This will insure that all gold stars, options, and game
459summary files will be stored in a location specific to each user.
460
461Setting this up is fairly simple.  There are two ways to do it:
462manually and using a separate program "tuxmathadmin".  The first two
463steps are the same either way:
464
4651. Decide where you want this information stored.  You might want to
466put it on a central server.  In the appropriate place (let's say it's
467"/servervolume/"), create a directory which for current purposes we'll
468call "tuxmath_users".
469
4702. Set it up so that tuxmath automatically finds the user directory
471tree.  Find the global configuration file (e.g., under Linux it would
472usually be /usr/local/share/tuxmath/missions/options; on Mac OSX it is
473a file called "options" in the .dmg bundle).  Set the "homedir"
474property (at the very end of the file) to point to your home directory
475tree. Make sure you uncomment (remove the "#" symbol) from that line.
476
477Be aware that you can also employ the command line option "--homedir
478/severvolume/tuxmath_users" (along with any other options) upon
479launching tuxmath.  An individual classroom could make use of this
480school-wide service by specifying (in the option-file syntax) homedir
481= /servervolume/tuxmath_users/2nd\ grade/Mrs.\ Johnson so that
482students in a particular classroom only have to choose among their own
483class and not go through the full login "tree".
484
485If you are using tuxmathadmin, here are the remaining steps:
486
4873. Using a spreadsheet program, create a spreadsheet that reflects the
488way you want to organize the login system.  The following example
489should illustrate the syntax (try viewing this with a fixed-width font
490if the spacing is unclear):
491
492        Col 1                  Col 2                           Col 3
493        1st Grade
494                               Mr. Jones
495                                                               KidA
496                                                               KidB
497                                                               KidC
498                               Mrs. Smith
499                                                               Kid1
500                                                               Kid2
501        2nd Grade
502                               Mrs. Wilson
503                                                               Kid a
504                                                               Kid b
505                                                               Kid c
506                                                               Kid d
507
508        This indicates that three kids (named "KidA", "KidB", and
509        "KidC") are in Mr.  Jones' 1st grade class; two kids ("Kid1"
510        and "Kid2") are in Mrs. Smith's 1st grade class, and there are
511        4 in Mrs. Wilson's 2nd grade class.  The school presumably has
512        more kids and more classrooms than this, but this is a short
513        example intended to illustrate the organization of the file.
514
515	Note that it's flexible: you don't have to divide things by
516	grade, teacher, and kid; you could just do teacher & kid, or
517	just kids, or you could do something even more complicated
518	("East Campus", "1st grade", etc.). If you were just wanting
519	to set things up for home use with a single login you could
520	just list the names of your kids in a single column and that
521	would be it.
522
523	Save the spreadsheet as a comma-separated-value file (.csv
524        file).  In case you have to prepare it manually (say, with a
525        text editor) the resulting CSV file would look like this:
526
527	"1st Grade",,
528	,"Mr. Jones",
529	,,"KidA"
530	,,"KidB"
531	,,"KidC"
532	,"Mrs. Smith",
533	,,"Kid1"
534	,,"Kid2"
535	"2nd Grade",,
536	,"Mrs. Wilson",
537	,,"Kid a"
538	,,"Kid b"
539	,,"Kid c"
540	,,"Kid d"
541
5424. Create the directory hierarchy with the following command (executed
543from the command line, aka shell):
544
545	tuxmathadmin --createhomedirs userfile.csv
546
547	OR
548
549	tuxmathadmin --path /servervolume/tuxmath_users --createhomedirs userfile.csv
550
551(use the 2nd syntax if you haven't updated the global configuration
552file yet as in step 2 above).  Here, "userfile.csv" is the name of the
553file that you created in the previous step.  It should tell you that
554it's creating all the user directories and complete without error.
555Note that "tuxmathadmin -h" gives help, including a list of the things
556that tuxmathadmin can do.
557
5585. Optionally, in the "tuxmath_users" directory you can also create a
559file that poses a question at each step of the hierarchy.  For the
560example above, it might contain three lines:
561
562	Choose your grade:
563	Choose your teacher:
564	Who are you?
565
566You need to save this as a raw text file with the name
567"user_login_questions" ("user_login_questions.txt" on Windows) in the
568top level of the user hierarchy directory
569(/servervolume/tuxmath_users).  If you omit this file, then students
570will simply be presented with the list without any kind of prompt.
571
5726. Decide on how you want users to compete for high scores.  For the
573example above, suppose you want each student to compete against the
574other kids in their same classroom.  You would configure this with the
575following command:
576
577	tuxmathadmin --confighighscores --level 3
578
579"tuxmathadmin -h" gives detail about the meaning of the choices of
580different levels.
581
5827. Optionally, at least under Linux (and probably other OSes) you can
583also configure certain tasks to run automatically using "cron."  For
584example, if you want to clear all the students' gold stars on a daily
585basis, you can put a script that executes
586
587	tuxmathadmin --cleargoldstars
588
589in the /etc/cron.daily directory. See the cron documentation for more
590detail.  You may also want to run tuxmathadmin with --consolidatelogs
591to generate daily reports (see below).
592
593If you instead choose to configure TuxMath manually, these are the steps:
594
5953. In tuxmath_users, create a text file called "user_menu_entries."
596This file contains the list of choices that students will be presented
597with upon login, one entry per line.  For example, a large school with
598many classrooms might have choices called "Kindergarten," "1st grade,"
599and so on.
600
6014. In the same directory, create sub-directories that have the same
602names that appear in user_menu_entries.
603
6045. Create further user_menu_entries and further subdirectories inside
605each of these.  For example, in "Kindergarten" you might want to
606create directories for each classroom, say "Mrs. Smith" and "Mr.
607Jones."  A smaller school might choose to skip the by-grade
608organization and go straight to each classroom; a single computer in a
609single classroom might skip these altogether.  Always make sure that
610the user_menu_entry file matches the directory structure (although
611having extra directories will not cause a problem).
612
613You have to make sure that all the write permissions are set correctly
614for the students to be able to write to these directories.
615
6166. At the finest level, create a menu item and one subdirectory for
617each student.
618
6197. Optionally, perform the tasks described above in step 5 of the
620"tuxmathadmin" configuration (creation of the user_login_questions
621file).
622
6238. Optionally, you can create an empty file called "highscores"
624("highscores.txt" on Windows) at whatever level of the hierarchy you
625want users to be competing for the high score.  For example, if you
626want the high scores to be grade-wide, then put a "highscores" file in
627each grade's directory.  Alternatively, each classroom could have it's
628own, or even each student.  If you do nothing, then each student will
629have a private high score table.  (In case of multiple highscores
630files, the one at the lowest level of the hierarchy wins.)
631
632Note there is no security insuring that students select themselves.
633
634
635Tracking Progress in Multiple-User Configurations
636-------------------------------------------------
637
638tuxmathadmin contains a feature, "--consolidatelogs", that creates a
639consolidated_log.csv file in all directories that are one above the
640lowest level.  The basic use-case is to combine the reports on all
641students in a particular class.  Teachers/parents can open this file
642with a spreadsheet program as described above under "Game Summary
643Files."
644
645Command Line Options
646--------------------
647
648NOTE: Tuxmath now has many pre-packaged "missions" (lessons), as  well
649as four arcade-style open-ended games of progressive difficulty, so
650there is much less need to change settings.  If desired, editing the
651config file is a much better way to control the behavior of TuxMath
652than the command-line options, for the most part.  However, many
653options are still supported.
654
655Tips on running from the command line:
656
657Linux:
658-----
659
660Just open a command prompt.
661
662Windows:
663-------
664
665To be prompted for command line options, run tuxmath
666from the "Run" dialog or the "C:> Command Prompt" console. Type
667"TuxMath.exe" followed by any desired options (see below). If it does
668not run, make sure the full path to the program (e.g. C:\Program
669Files\TuxMath\TuxMath.exe) is known to Windows, either through Control
670Panel settings or by changing to the directory containing TuxMath.exe
671before issuing the command.
672
673MacOS:
674-----
675
676[ UNDER CONSTRUCTION ]  Just double-click the "tuxmath" icon. ???  To
677be prompted for command line options (see below), hold the [OPTION]
678key as you double-click the icon.
679
680
681The following command-line options can be sent to the program:
682
683NEW as of 1.8.0 - run-time debugging output.  Tuxmath now has a system
684to activate debugging output of various subsystems.  Note that the
685extent to which the new system is utilized varies a lot - some of
686these flags don't do much as of yet.  The names are fairly
687self-explanatory and generally refer to specific source code files in
688Tuxmath:
689
690	--debug-all
691	--debug-setup
692	--debug-fileops
693	--debug-loaders
694	--debug-titlescreen
695	--debug-menu
696	--debug-menu-parser
697	--debug-game
698	--debug-factoroids
699	--debug-lan
700	--debug-mathcards
701	--debug-sdl
702	--debug-lessons
703	--debug-highscore
704	--debug-options
705
706     --optionfile filename - play game based on settings in the named file (see
707                         below for more on tuxmath config files). Tuxmath will
708                         look for a valid config file with a matching name in
709                         the following locations:
710                         	1. current working directory
711				2. as an absolute pathname
712				3. in the missions directory with tuxmath's
713                                   other data files.
714				4. in the user's tuxmath options directory
715                                   (e.g. /home/laura/.tuxmath/filename
716                                5. in the user's home directory.
717
718     --playthroughlist - Game consists of working through a list of questions
719      -r                 generated based on the selected options (or defaults).
720                         If a comet strikes a city without being shot down by
721                         the player, the question is reinserted into the list
722                         in a random location. If the player answers all questions
723                         correctly before the cities are destroyed, he/she wins.
724                         If all cities get destroyed, the game ends in defeat.
725
726     --answersfirst   -  to ask questions in format: ? + num2 = num3 instead of
727                         default format: num1 + num2 = ?.
728
729     --answersmiddle  -  to ask questions in format: num1 + ? = num3 instead of
730                         default format: num1 + num2 = ?.
731
732     --fullscreen     -  Run the game in full screen, instead of in a window,
733      -f                 if possible.
734
735     --windowed       -  Run the game in a 640 x 480 window.
736      -w
737
738     --nosound        -  Do not play any sounds or music.
739      -s
740     --quiet
741      -q
742
743     --nobackground   -  Do not display photographic backgrounds in game.
744      -b                 (Useful on slower systems.)
745
746     --keypad         -  Display an on-screen numeric keypad.  (Useful
747      -k                 for touch screens or in place of a physical keyboard.)
748
749     --operator OP    -  Add an operator to the game (will cause the program
750      -o OP              to ignore saved option screen settings).  You can
751                         use this switch multiple times to run the game
752                         with multiple operators.
753
754                         Valid values for "OP" are:
755
756                           add
757                           subtract
758                           multiply
759                           divide
760
761     --demo           -  Demo mode.  The game will cycle back and forth
762      -d                 between the title and the game, and it will
763                         auto-play the game.  The only user interaction
764                         can be for quitting or pausing.
765
766     --allownegatives    Allows subtraction answers to be less than zero.
767      -n                 When selected, the led numbers at the top of the
768                         screen will include a fourth digit for the '-' sign.
769                         Also, if --keypad is selected, the '-' and '+' may
770                         be grayed-out depending if negatives are allowed.
771
772
773    These command-line options display useful information, but the program
774    does not attempt to start up in interactive mode.
775
776     --help           -  Display a short help message, explaining how to
777      -h                 play the game.
778
779     --usage          -  Display the available command-line options.
780      -u
781
782     --version        -  Display the version of "tuxmath" you're running.
783      -v
784
785     --copyright      -  Display copyright information
786      -c
787
788
789
790License ------- "Tux, of Math Command" is Free Software.  The compiled
791program is distributed under the GNU General Public License (GPL),
792Version 3 (or, at your option, any later version).  TuxMath's various
793source code files are licensed under either GPL2 or greater, GPL 3 or
794greater, or non-restrictive licenses similar to the BSD and MIT
795licenses.  The data files are licensed under non-restrictive Creative
796Commons licenses or under the GPL itself.  See COPYING for further
797information.
798
799
800Credits
801-------
802
803Designed by Sam "Criswell" Hart  <criswell@geekcomix.com>
804Original software created by Bill Kendrick  <bill@newbreedsoftware.com>
805
806Current co-maintainers/lead programmers:
807
808David Bruce <davidstuartbruce@gmail.com>
809Tim Holy <tholy@wustl.edu>
810
811Please see the game's "Credits" screen for a complete list of
812contributors.
813
814
815Software Used
816-------------
817
818GNU C Compiler, GNU Make, GNU Autoconf, GNU Automake, GNU Gettext, GNU
819Libtool
820	http://www.gnu.org/
821
822SDL and associated libraries:
823	http://www.libsdl.org/
824
825The GIMP
826	http://www.gimp.org/
827
828Vim (Vi IMproved)
829	http://www.vim.org/
830
831Git
832    (GET CORRECT URL)
833
834Inkscape
835    (GET CORRECT URL)
836
837CMake (for Mac OSX build)
838    (GET CORRECT URL)
839
840Mingw cross-compiler port of GCC and Mingw Cross Environment
841    (for cross-compiled Windows build)
842    (GET CORRECT URL for mingw project)
843	http://mingw-cross-env.nongnu.org
844
845
846SDL_rotozoom was copied from the SDL_gfx library and re-licensed (for
847the purposes of TuxMath only) to GPL
848	http://www.ferzkopp.net/Software/SDL_gfx-2.0/
849

README_DATA_LICENSES

104 May 2011
2
3About The Images and Sounds Used In This Game
4---------------------------------------------
5
6All Tux4Kids programs are intended to be fully compliant with the Debian Free
7Software Guidelines.  To the best of my knowledge, the programs are currently
8in compliance.  Any deviation from these guidelines is unintentional, and
9should be brought to the attention of the Tux4Kids developers.
10
11The graphics and sounds used in tuxmath are all either licensed under terms
12that allow free redistribution, or are in the public domain, as summarized
13below to the best of my (David Bruce's) knowledge. Licenses are GPL except as
14otherwise noted.
15
16During 2009 and 2010, nearly all of the png images in TuxMath were converted to
17SVG equivalents by members of the Tux4Kids project using free software tools.
18The derived images are licensed under the same terms as the originals.
19
20data/images/backgrounds/*:
21  0.jpg - 3.jpg: Created by Sam Hart or Bill Kendrick with the GIMP.
22  4.jpg -12.jpg: Modified by David Bruce using the GIMP from images
23                 released into the public domain by NASA:
24  http://hubblesite.org/newscenter/newsdesk/archive/releases/2005/04/
25  http://hubblesite.org/newscenter/newsdesk/archive/releases/2004/52/
26  http://spaceflight.nasa.gov/gallery/images/station/crew-7/html/iss007e16249.html
27  http://spaceflight.nasa.gov/gallery/images/apollo/apollo16/html/as16-120-19187.html
28  http://hubblesite.org/newscenter/newsdesk/archive/releases/2003/24/
29  http://hubblesite.org/newscenter/newsdesk/archive/releases/2003/11/
30  http://hubblesite.org/newscenter/newsdesk/archive/releases/1999/29/
31  http://hubblesite.org/newscenter/newsdesk/archive/releases/2003/28/
32  http://hubblesite.org/newscenter/newsdesk/archive/releases/2005/12/image/a
33
34data/images/cities/*: Sam Hart/Bill Kendrick.
35data/images/comets/*: Sam Hart/Bill Kendrick, some images modified by either
36  David Bruce or Tim Holy.
37data/images/igloos/*:
38data/images/penguins/*:
39  Images either created by Tim Holy, Linnea Holy, and Kendra Swanson or modified
40  by these authors from Creative Commons-licensed material at:
41  http://www.openclipart.org/
42  (license text: http://creativecommons.org/licenses/publicdomain/)
43data/images/sprites/*:
44  All tux* images modified by David Bruce from either Larry Ewing's Tux drawing
45  or from GPL-licensed tux_config.png file in KDEArtwork from KDE. Goldstar*
46  images created by David Bruce using The GIMP. Other images
47  brought in from GPL-licensed images in Tux Typing.
48data/imates/status/*:
49  right.png, right_gray.png, left.png, left_gray.png, stop.png modified from
50  GPL-licensed KDE icons by David Bruce using the GIMP. All other images created
51  by Sam Hart or Bill Kendrick.
52data/images/title/*:
53  menu_bkg.jpg modified by David Bruce from public domain image from NASA.
54  title1.png modified by David Bruce from earlier image by Sam Hart.
55data/images/tux/*:
56  All images either created by Sam Hart or modified from Larry Ewing's
57  Tux drawing <ltlewing@isc.tamu.edu>.
58data/images/factoroids/*:
59  New "ship*.png" images created by Teejay Deguzman, other images created by Bill
60  Kendrick or Jesus Magar.
61
62data/sounds/*
63  Emmett Plant (emmett@sonivius.com) is the author of tuxi.ogg and released
64  it into the public domain.
65  The brief .wav files were either made by Sam Hart or Bill Kendrick or obtained
66  from the public-domain section of www.partnersinrhyme.com.
67  The three original background music files (game*.mod) are also public domain.
68  They are:
69  - "Beyond The Horizon", by Mystra of Stone Arts, 1994.
70  - "CCCP Main", by Groo of CNCD, 1994.
71  - "Soft Brilliance", by Tjoppbass, 1994.
72  The three new music files are license under the Creative Commons Attribution Share-
73  Alike 3.0 license. They were obtained from Jamendo.  They are:
74  - "Rush", by Serberis.
75  - "On the Edge of the Universe", by Synthaurion.
76  - "Gravity", by Serberis.
77