Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 756 Bytes

usage.rst

File metadata and controls

47 lines (26 loc) · 756 Bytes
.. index:: usage


Usage

.. index:: requirements

Requirements

In order to use the Micromouse Maze Simulator you need:

  • Python 3.5 (or higher).
.. index:: installation

Installation

Installation is very straight-forward using Python's pip:

pip install mmsim

This will install all the required dependencies and will provide you with the mmsim command.

.. index:: launching

Launching

To run the simulator simply:

mmsim

This will, the first time, download a set of mazes from micromouseonline.

If you have a local maze files collection in text format you may use that instead:

mmsim your/local/collection/path/