schrum2 / MM-NEATv2

MM-NEAT version 2.0 is no longer supported. Please get MM-NEAT 3+ from https://github.com/schrum2/MM-NEAT
Other
11 stars 5 forks source link

Documentation for interactive evolution tasks #443

Closed schrum2 closed 7 years ago

schrum2 commented 7 years ago

Create a file called INTERACTIVE_EVOLUTION.txt in the root MM-NEAT directory.

This plain text file should provide documentation on the various types of interactive evolution tasks available in MM-NEAT. First, include a short intro. This should describe how all of the system works, and describe the buttons on the interface that are common across all tasks.

Then use asterisks as bullets to label each type of task, the exact package path and class name that contains the task, and provide a short description of how the task works and what it does. For tasks that are based on someone else's previous work, provide the full citation, as in the comments of the files themselves (note that I have improved these ... use my updated versions). For the sound remixer and picture remixer, put (prototype) in parentheses by the name.

After describing each individual task, provide instructions at the end on how someone can extend InteractiveEvolutionTask to create their own interactive evolution task. List the abstract methods that they would need to override (this might also be a good chance to double-check the comments on those methods).