Move algo templates into separate repos

mackorone · Feb 3, 2019 · 659dfe9 · 659dfe9
1 parent 2e4b1a3
commit 659dfe9
Show file tree

Hide file tree

Showing 128 changed files with 111 additions and 2,021 deletions.
diff --git a/README.md b/README.md
@@ -5,14 +5,15 @@
 ## Table of Contents
 
 1. [Introduction](https://github.com/mackorone/mms#introduction)
-1. [Installation](https://github.com/mackorone/mms#installation)
+1. [Download](https://github.com/mackorone/mms#download)
 1. [Quick Start](https://github.com/mackorone/mms#quick-start)
 1. [Mouse API](https://github.com/mackorone/mms#mouse-api)
 1. [Cell Walls](https://github.com/mackorone/mms#cell-walls)
 1. [Cell Color](https://github.com/mackorone/mms#cell-color)
 1. [Cell Text](https://github.com/mackorone/mms#cell-text)
 1. [Reset Button](https://github.com/mackorone/mms#reset-button)
 1. [Maze File Format](https://github.com/mackorone/mms#maze-file-format)
+1. [Building From Source](https://github.com/mackorone/mms#building-from-source)
 1. [Acknowledgements](https://github.com/mackorone/mms#acknowledgements)
 
 ## Introduction
@@ -32,95 +33,26 @@ With it, you can:
 * Test your algorithm on custom maze files
 * Write code in any language you want
 
-For information about Micromouse, see the [Micromouse Wikipedia page](http://en.wikipedia.org/wiki/Micromouse).
-
 Previous versions of *mms* exist in the `old/` directory.
 
+For information about Micromouse, see the [Micromouse Wikipedia page](http://en.wikipedia.org/wiki/Micromouse).
 
-## Installation
-
-In the near future, we'll provide pre-compiled binaries. Until then, you need
-to build from source. At a high level, the steps are as follows:
-
-1. Install Qt and other dependencies
-1. Build `mms/src/sim/sim.pro`
-1. Run `mms/bin/sim`
-
-#### Windows
-
-Install Qt:
-
-1. Download the Qt open source installer: https://www.qt.io/download/
-1. If you don't already have a Qt account, you'll need to make one
-1. When prompted to select components, [choose "MinGW 7.3.0 64-bit"](https://github.com/mackorone/mms/blob/master/img/qt-install-windows-1.png)
-
-Build the project using QtCreator:
-
-1. Download or clone *mms*
-1. Run QtCreator and open `mms/src/sim/sim/pro` 
-1. Configure the project to [use "Desktop Qt 5.12.0 MinGW 64-bit"](https://github.com/mackorone/mms/blob/master/img/qt-install-windows-2.png)
-1. Build and run the project
-
-#### Mac OS
-
-TODO
-
-#### Linux (Ubuntu)
-
-Qt installation option #1: use the command line
-```
-sudo apt-get install qt5-default
-```
-
-Qt installation option #2: use the installer
-
-1. Download the Qt open source installer: https://www.qt.io/download/
-1. Make the installer executable: `chmod +x qt-unified-linux-x64-3.0.6-online.run`
-1. Run the installer executable: `./qt-unified-linux-x64-3.0.6-online.run`
-1. If you don't already have a Qt account, you'll need to make one
-1. When prompted to select components, [choose "Desktop gcc 64-bit"](https://github.com/mackorone/mms/blob/master/img/qt-install-ubuntu.png)
-1. Once the installer finishes, the `qmake` binary can be found in the installation directory
-
-More documentation:
-
-* https://wiki.qt.io/Install_Qt_5_on_Ubuntu
-* http://doc.qt.io/qt-5/linux.html
+## Download
 
-Clone, build, and run the project:
+Coming soon! For now, see [Building From Source](https://github.com/mackorone/mms#building-from-source).
 
-```bash
-# Clone the repo
-git clone [email protected]:mackorone/mms.git
-
-# Build the simulator
-cd mms/src/sim
-qmake && make
-
-# Run the simulator
-../../bin/sim
-```
 
 ## Quick Start
 
-#### Step 1: Create a new directory:
-
-```bash
-mkdir ~/Desktop/MyAlgo
-```
-
-#### Step 2: Copy over the template files:
-
-```bash
-cp src/mouse/templates/python/* ~/Desktop/MyAlgo
-```
+Writing a Micromouse algorithm is easy! Here are some available templates:
 
-#### Step 3: Configure your algorithm:
-
-Here are some examples:
-
-![](https://github.com/mackorone/mms/blob/master/img/python.png)
-![](https://github.com/mackorone/mms/blob/master/img/cpp.png)
+- C++: [mackorone/mms-cpp](https://github.com/mackorone/mms-cpp)
+- Python: [mackorone/mms-python](https://github.com/mackorone/mms-python)
 
+If a template for a particular language is missing, don't fret! Writing your
+own template is as easy as writing to stdout, reading from stdin, and
+implementing the [mouse API](https://github.com/mackorone/mms#mouse-api) below.
+If you have a template you'd like to share, please make a pull request!
 
 ## Mouse API
 
@@ -131,7 +63,7 @@ commands are listed below. Invalid commands are simply ignored.
 For commands that return a response, it's recommended to wait for the response
 before issuing additional commands.
 
-#### Summary 
+#### Summary
 
 ```c++
 int mazeWidth();
@@ -141,7 +73,7 @@ bool wallFront();
 bool wallRight();
 bool wallLeft();
 
-void moveForward();
+void moveForward();  // can result in "crash"
 void turnRight();
 void turnLeft();
 
@@ -152,7 +84,7 @@ void setColor(int x, int y, char color);
 void clearColor(int x, int y);
 void clearAllColor();
 
-void setText(int x, int y, std::string text);
+void setText(int x, int y, const std::string& text);
 void clearText(int x, int y);
 void clearAllText();
 
@@ -269,6 +201,31 @@ void ackReset();
 * **Response:** `ack` once the movement completes
 
 
+#### Example
+
+```c++
+Algorithm Request (stdout)  Simulator Response (stdin)   
+--------------------------  --------------------------
+mazeWidth                   16
+mazeWidth                   16
+wallLeft                    true
+setWall 0 0 W               <NO RESPONSE>
+wallFront                   false
+moveForward                 ack
+turnLeft                    ack
+wallFront                   true
+moveForward                 crash
+setColor 0 1 r              <NO RESPONSE>
+setText 0 1 whoops          <NO RESPONSE>
+wasReset                    false
+...                       
+wasReset                    true
+clearAllColor               <NO RESPONSE>
+clearAllText                <NO RESPONSE>
+ackReset                    ack
+```
+
+
 ## Cell Walls
 
 Cell walls allow the robot to diplay where it thinks walls exist, and where it
@@ -352,11 +309,11 @@ Result:
 
 Requirements for use with simulator:
 
-* Nonempty
-* Rectangular
-* Fully enclosed
-* Internally consistent
-  * E.g., if cell (0,1) has a north wall, then tile (0,2) should have a south wall
+* Maze must be nonempty
+* Maze must be rectangular
+* Maze must be fully enclosed
+* Maze must be internally consistent
+  * E.g., if cell (0,1) has a north wall, tile (0,2) should have a south wall
 
 Additional requirements for official Micromouse mazes:
 
@@ -367,8 +324,69 @@ Additional requirements for official Micromouse mazes:
 * Has walls attached to every peg except the center peg
 * Is unsolvable by a wall-following robot
 
-Other formats are not supported at this time. However, there is a CLI tool that can easily convert between formats: https://github.com/mackorone/maze
+Other formats are not supported at this time. However, there is a CLI tool that
+can easily convert between formats:
+[mackorone/maze](https://github.com/mackorone/maze).
+
+
+## Building From Source
+
+If you want to write code for the simulator itself, you'll need to build the
+project from source. Below are some OS-specific instructions.
+
+#### Windows
+
+Install Qt:
+
+1. Download the Qt open source installer: https://www.qt.io/download/
+1. If you don't already have a Qt account, you'll need to make one
+1. When prompted to select components, [choose "MinGW 7.3.0 64-bit"](https://github.com/mackorone/mms/blob/master/img/qt-install-windows-1.png)
+
+Build the project using QtCreator:
+
+1. Download or clone *mms*
+1. Run QtCreator and open `mms/src/sim/sim/pro` 
+1. Configure the project to [use "Desktop Qt 5.12.0 MinGW 64-bit"](https://github.com/mackorone/mms/blob/master/img/qt-install-windows-2.png)
+1. Build and run the project
+
+#### Mac OS
+
+COMING SOON
+
+#### Linux (Ubuntu)
+
+Qt installation option #1: use the command line
+```
+sudo apt-get install qt5-default
+```
+
+Qt installation option #2: use the installer
+
+1. Download the Qt open source installer: https://www.qt.io/download/
+1. Make the installer executable: `chmod +x qt-unified-linux-x64-3.0.6-online.run`
+1. Run the installer executable: `./qt-unified-linux-x64-3.0.6-online.run`
+1. If you don't already have a Qt account, you'll need to make one
+1. When prompted to select components, [choose "Desktop gcc 64-bit"](https://github.com/mackorone/mms/blob/master/img/qt-install-ubuntu.png)
+1. Once the installer finishes, the `qmake` binary can be found in the installation directory
+
+More documentation:
 
+* https://wiki.qt.io/Install_Qt_5_on_Ubuntu
+* http://doc.qt.io/qt-5/linux.html
+
+Clone, build, and run the project:
+
+```bash
+# Clone the repo
+git clone [email protected]:mackorone/mms.git
+
+# Build the simulator
+cd mms/src/sim
+qmake && make
+
+# Run the simulator
+../../bin/sim
+```
 
 ## Acknowledgements
 

diff --git a/img/cpp.png b/img/cpp.png
diff --git a/img/python.png b/img/python.png
diff --git a/src/sim/Assert.h → src/Assert.h b/src/sim/Assert.h → src/Assert.h
diff --git a/src/sim/BufferInterface.cpp → src/BufferInterface.cpp b/src/sim/BufferInterface.cpp → src/BufferInterface.cpp
diff --git a/src/sim/BufferInterface.h → src/BufferInterface.h b/src/sim/BufferInterface.h → src/BufferInterface.h
diff --git a/src/sim/Color.cpp → src/Color.cpp b/src/sim/Color.cpp → src/Color.cpp
diff --git a/src/sim/Color.h → src/Color.h b/src/sim/Color.h → src/Color.h
diff --git a/src/sim/ColorManager.cpp → src/ColorManager.cpp b/src/sim/ColorManager.cpp → src/ColorManager.cpp
diff --git a/src/sim/ColorManager.h → src/ColorManager.h b/src/sim/ColorManager.h → src/ColorManager.h
diff --git a/src/sim/ConfigDialog.cpp → src/ConfigDialog.cpp b/src/sim/ConfigDialog.cpp → src/ConfigDialog.cpp
diff --git a/src/sim/ConfigDialog.h → src/ConfigDialog.h b/src/sim/ConfigDialog.h → src/ConfigDialog.h
diff --git a/src/sim/Dimensions.cpp → src/Dimensions.cpp b/src/sim/Dimensions.cpp → src/Dimensions.cpp
diff --git a/src/sim/Dimensions.h → src/Dimensions.h b/src/sim/Dimensions.h → src/Dimensions.h
diff --git a/src/sim/Direction.cpp → src/Direction.cpp b/src/sim/Direction.cpp → src/Direction.cpp
diff --git a/src/sim/Direction.h → src/Direction.h b/src/sim/Direction.h → src/Direction.h
diff --git a/src/sim/Driver.cpp → src/Driver.cpp b/src/sim/Driver.cpp → src/Driver.cpp
diff --git a/src/sim/Driver.h → src/Driver.h b/src/sim/Driver.h → src/Driver.h
diff --git a/src/sim/FontImage.cpp → src/FontImage.cpp b/src/sim/FontImage.cpp → src/FontImage.cpp
diff --git a/src/sim/FontImage.h → src/FontImage.h b/src/sim/FontImage.h → src/FontImage.h
diff --git a/src/sim/GeometryUtilities.cpp → src/GeometryUtilities.cpp b/src/sim/GeometryUtilities.cpp → src/GeometryUtilities.cpp
diff --git a/src/sim/GeometryUtilities.h → src/GeometryUtilities.h b/src/sim/GeometryUtilities.h → src/GeometryUtilities.h
diff --git a/src/sim/Logging.cpp → src/Logging.cpp b/src/sim/Logging.cpp → src/Logging.cpp
diff --git a/src/sim/Logging.h → src/Logging.h b/src/sim/Logging.h → src/Logging.h
diff --git a/src/sim/Main.cpp → src/Main.cpp b/src/sim/Main.cpp → src/Main.cpp
diff --git a/src/sim/Map.cpp → src/Map.cpp b/src/sim/Map.cpp → src/Map.cpp
diff --git a/src/sim/Map.h → src/Map.h b/src/sim/Map.h → src/Map.h
diff --git a/src/sim/Maze.cpp → src/Maze.cpp b/src/sim/Maze.cpp → src/Maze.cpp
diff --git a/src/sim/Maze.h → src/Maze.h b/src/sim/Maze.h → src/Maze.h
diff --git a/src/sim/MazeGraphic.cpp → src/MazeGraphic.cpp b/src/sim/MazeGraphic.cpp → src/MazeGraphic.cpp
diff --git a/src/sim/MazeGraphic.h → src/MazeGraphic.h b/src/sim/MazeGraphic.h → src/MazeGraphic.h
diff --git a/src/sim/MazeView.cpp → src/MazeView.cpp b/src/sim/MazeView.cpp → src/MazeView.cpp
diff --git a/src/sim/MazeView.h → src/MazeView.h b/src/sim/MazeView.h → src/MazeView.h
diff --git a/src/sim/Mouse.cpp → src/Mouse.cpp b/src/sim/Mouse.cpp → src/Mouse.cpp
diff --git a/src/sim/Mouse.h → src/Mouse.h b/src/sim/Mouse.h → src/Mouse.h
diff --git a/src/sim/MouseGraphic.cpp → src/MouseGraphic.cpp b/src/sim/MouseGraphic.cpp → src/MouseGraphic.cpp
diff --git a/src/sim/MouseGraphic.h → src/MouseGraphic.h b/src/sim/MouseGraphic.h → src/MouseGraphic.h
diff --git a/src/sim/Polygon.cpp → src/Polygon.cpp b/src/sim/Polygon.cpp → src/Polygon.cpp
diff --git a/src/sim/Polygon.h → src/Polygon.h b/src/sim/Polygon.h → src/Polygon.h
diff --git a/src/sim/ProcessUtilities.cpp → src/ProcessUtilities.cpp b/src/sim/ProcessUtilities.cpp → src/ProcessUtilities.cpp
diff --git a/src/sim/ProcessUtilities.h → src/ProcessUtilities.h b/src/sim/ProcessUtilities.h → src/ProcessUtilities.h
diff --git a/src/sim/RGB.h → src/RGB.h b/src/sim/RGB.h → src/RGB.h
diff --git a/src/sim/Settings.cpp → src/Settings.cpp b/src/sim/Settings.cpp → src/Settings.cpp
diff --git a/src/sim/Settings.h → src/Settings.h b/src/sim/Settings.h → src/Settings.h
diff --git a/src/sim/SettingsMazeFiles.cpp → src/SettingsMazeFiles.cpp b/src/sim/SettingsMazeFiles.cpp → src/SettingsMazeFiles.cpp
diff --git a/src/sim/SettingsMazeFiles.h → src/SettingsMazeFiles.h b/src/sim/SettingsMazeFiles.h → src/SettingsMazeFiles.h
diff --git a/src/sim/SettingsMisc.cpp → src/SettingsMisc.cpp b/src/sim/SettingsMisc.cpp → src/SettingsMisc.cpp
diff --git a/src/sim/SettingsMisc.h → src/SettingsMisc.h b/src/sim/SettingsMisc.h → src/SettingsMisc.h
diff --git a/src/sim/SettingsMouseAlgos.cpp → src/SettingsMouseAlgos.cpp b/src/sim/SettingsMouseAlgos.cpp → src/SettingsMouseAlgos.cpp
diff --git a/src/sim/SettingsMouseAlgos.h → src/SettingsMouseAlgos.h b/src/sim/SettingsMouseAlgos.h → src/SettingsMouseAlgos.h
diff --git a/src/sim/SimUtilities.cpp → src/SimUtilities.cpp b/src/sim/SimUtilities.cpp → src/SimUtilities.cpp
diff --git a/src/sim/SimUtilities.h → src/SimUtilities.h b/src/sim/SimUtilities.h → src/SimUtilities.h
diff --git a/src/sim/Tile.cpp → src/Tile.cpp b/src/sim/Tile.cpp → src/Tile.cpp
diff --git a/src/sim/Tile.h → src/Tile.h b/src/sim/Tile.h → src/Tile.h
diff --git a/src/sim/TileGraphic.cpp → src/TileGraphic.cpp b/src/sim/TileGraphic.cpp → src/TileGraphic.cpp
diff --git a/src/sim/TileGraphic.h → src/TileGraphic.h b/src/sim/TileGraphic.h → src/TileGraphic.h
diff --git a/src/sim/TileGraphicTextCache.cpp → src/TileGraphicTextCache.cpp b/src/sim/TileGraphicTextCache.cpp → src/TileGraphicTextCache.cpp
diff --git a/src/sim/TileGraphicTextCache.h → src/TileGraphicTextCache.h b/src/sim/TileGraphicTextCache.h → src/TileGraphicTextCache.h
diff --git a/src/sim/TransformationMatrix.cpp → src/TransformationMatrix.cpp b/src/sim/TransformationMatrix.cpp → src/TransformationMatrix.cpp
diff --git a/src/sim/TransformationMatrix.h → src/TransformationMatrix.h b/src/sim/TransformationMatrix.h → src/TransformationMatrix.h
diff --git a/src/sim/Triangle.h → src/Triangle.h b/src/sim/Triangle.h → src/Triangle.h
diff --git a/src/sim/TriangleGraphic.h → src/TriangleGraphic.h b/src/sim/TriangleGraphic.h → src/TriangleGraphic.h
diff --git a/src/sim/TriangleTexture.h → src/TriangleTexture.h b/src/sim/TriangleTexture.h → src/TriangleTexture.h
diff --git a/src/sim/VertexGraphic.h → src/VertexGraphic.h b/src/sim/VertexGraphic.h → src/VertexGraphic.h
diff --git a/src/sim/VertexTexture.h → src/VertexTexture.h b/src/sim/VertexTexture.h → src/VertexTexture.h
diff --git a/src/sim/Window.cpp → src/Window.cpp b/src/sim/Window.cpp → src/Window.cpp
diff --git a/src/sim/Window.h → src/Window.h b/src/sim/Window.h → src/Window.h
diff --git a/src/sim/sim.pro → src/mms.pro b/src/sim/sim.pro → src/mms.pro
@@ -14,7 +14,7 @@ SOURCES += $$files(*.cpp, true)
 HEADERS += $$files(*.h, true)
 RESOURCES = resources.qrc
 
-DESTDIR     = ../../bin
-MOC_DIR     = ../../build/moc/sim
-OBJECTS_DIR = ../../build/obj/sim
-RCC_DIR     = ../../build/rcc/sim
+DESTDIR     = ../bin
+MOC_DIR     = ../build/moc
+OBJECTS_DIR = ../build/obj
+RCC_DIR     = ../build/rcc
diff --git a/src/mouse/algos/leftWallFollow/Algo.cpp b/src/mouse/algos/leftWallFollow/Algo.cpp
diff --git a/src/mouse/algos/leftWallFollow/Algo.h b/src/mouse/algos/leftWallFollow/Algo.h
diff --git a/src/mouse/algos/leftWallFollow/Interface.cpp b/src/mouse/algos/leftWallFollow/Interface.cpp