Skip to content
Peetwa edited this page Mar 25, 2017 · 7 revisions

Table of Contents

How to start contributing

Gitter

How to join Gitter?

  1. Click the green gitter join chat button just above the gifs of META-MarIO on the Github page
  2. Click the orange join room button at the bottom of the Gitter page

What is Gitter?

Gitter is a chat room connected the git repository and waffle. It is also the chat system we use for this project. ##Waffle

How to join Waffle?

  1. Click this link: https://waffle.io/wert23239/Meta-MarIO/join

What is Waffle?

Waffle is a work flow application that allows us to define tasks, assign them to people, give them due dates, and move them through the columns automatically by using github.

Using Waffle for the first time

  1. Click Add Issue: to create a new card for unique enhancement or bug in Meta-MarIO you'd like to work on or have someone else work on.
  2. For Title type what the bug or enhancement is and then click Add. Your card will now be in the Backlog column.
  3. Click on github logo in the bottom right of the card. Your card will now be displayed in the issues tab of the repository.
  4. Click the pencil icon in the top right of your comment. Write out a description of the problem and then bellow write out the steps you believe you need to take to finish the task, separate the steps by line. Once all the steps are written, highlight them and click the Add a task list icon in the header of the comment.
  5. Finish by clicking update comment
  6. Because this is your first time contributing, it will stay in the Backlog column of Gitter until a collaborator approves the card and moves it to ready where you can begin working on it.

Navigating the GUI

Variables

Species

The population size

Genome

Copies of the same species.

Score

Collected by killing enemies, collecting coins, and reaching high on the flag at the end of the level

Novelty

Has this option been explored before

Timeout

Number of frames a Genome has left before he is killed.

GUI

Max Fitness: Show Map: Display neural network. Round Amount: How many times we run the last state through the entire for each gene. Continuous Play: If checked each genome will run a slight variations of the same species. Show Mutate: Displays mutation rate Timeout Constant: Number of frames Mario starts with before he times out and is killed off. Rightmost Timeout: If checked going to the right will reset the Timeout to the timeout constant. Novelty Timeout: If checked finding a new path will reset the Timeout to Timeout Constant ScoreOn: If checked, the genome will gain fitness from increasing score NoveltyOn: If checked, the genome will gain fitness from Novelty RightmostOn: If checked, the genome will gain fitness from moving to the right NoveltyConstant: The number of times a genome can go through a tile in a given generation before that tile will lose its novelty. It loses its novelty for one generation Save: Saves the "NameOfFile" typed into the text box bellow I.E. "Level12.pool" Load: Loads the "NameOfFile" from the text box bellow I.E. "Level12.pool" Restart: Resets the species but stays on the current level. Play Top: Plays the genome with the top fitness in your species pool

Hide Banner

If checked variables will not be displayed at the top

Map

what the genome sees It's neural network. Connecting elements in the map and Keypresses.

Line

a complete gene

Green line

Greyed out

That Gene is disables because of a mutation

White boxes

Platforms you can stand on

Black boxes

Moving objects I.E. Mushrooms and Enemies

Neuron

Free floating box

Green line