# MicroMouse
This is the main repository for the MicroMouse API Project.
## Introduction
Having recently heard about the [MicroMouse Comepetition](https://ukmars.org/contests/micromouse/),
I have acquired an interest in developing an online version for the same.
This project aims to provide a virtual maze with an local API to access the maze,
and the contest will be to make a standalone mouse programs, that can use various techniques
such as:
1. [Flood fill algorithm](https://en.wikipedia.org/wiki/Flood_fill)
2. [Q Learning](https://en.wikipedia.org/wiki/Q-learning)
3. [NEAT Algorithm](https://en.wikipedia.org/wiki/Neuroevolution_of_augmenting_topologies)
4. [A* Path Finding Algorithm](https://en.wikipedia.org/wiki/A*_search_algorithm)
And many more such algorithms, to get their mouse to the finish line as fast as possible.
## Components
The Components involved in this repository are:
1. [Maze Generator API](https://github.com/kshitijaucharmal/Maze-Generation)
2. Mouse Example (Not Completed)
3. Documentation (Not Completed)
## Usage
Clone the repository with submodules
```bash
# Instructions for installation here.
```
Use the Documentation to get started.
## Contributing
```bash
Contributing Instructions here.
```
(For now, you can just fork the repo and suggest changes, as it is in early development)
## Thanks!
Raw data
{
"_id": null,
"home_page": "",
"name": "micromouse-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,micromouse,contest,env,maze,maze-generation",
"author": "Kshitij Aucharmal",
"author_email": "kshitijaucharmal21@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2d/b1/93aa7fada1f39b97fcd60c85f342f3a99102a7559e4de7de2406e0374162/micromouse-api-0.0.2.tar.gz",
"platform": null,
"description": "\n# MicroMouse\n\nThis is the main repository for the MicroMouse API Project.\n\n## Introduction\nHaving recently heard about the [MicroMouse Comepetition](https://ukmars.org/contests/micromouse/),\nI have acquired an interest in developing an online version for the same.\nThis project aims to provide a virtual maze with an local API to access the maze, \nand the contest will be to make a standalone mouse programs, that can use various techniques\nsuch as:\n1. [Flood fill algorithm](https://en.wikipedia.org/wiki/Flood_fill)\n2. [Q Learning](https://en.wikipedia.org/wiki/Q-learning)\n3. [NEAT Algorithm](https://en.wikipedia.org/wiki/Neuroevolution_of_augmenting_topologies)\n4. [A* Path Finding Algorithm](https://en.wikipedia.org/wiki/A*_search_algorithm)\n\nAnd many more such algorithms, to get their mouse to the finish line as fast as possible.\n\n## Components\nThe Components involved in this repository are:\n1. [Maze Generator API](https://github.com/kshitijaucharmal/Maze-Generation)\n2. Mouse Example (Not Completed)\n3. Documentation (Not Completed)\n\n## Usage\nClone the repository with submodules\n```bash\n# Instructions for installation here.\n```\n\nUse the Documentation to get started.\n\n## Contributing\n```bash\nContributing Instructions here.\n```\n\n(For now, you can just fork the repo and suggest changes, as it is in early development)\n\n## Thanks!\n",
"bugtrack_url": null,
"license": "",
"summary": "API for online MicroMouse",
"version": "0.0.2",
"project_urls": null,
"split_keywords": [
"python",
"micromouse",
"contest",
"env",
"maze",
"maze-generation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c83b0df9ee34d7a403311d99b28138d3e12417cb1055b1df4fdf7d5b327be74f",
"md5": "0464dfe89f2effe822cdbf3182525fe6",
"sha256": "a3e83ebadc2f93c2c6377b6c84c23e912624a45081f14547e73f4714d9c98618"
},
"downloads": -1,
"filename": "micromouse_api-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0464dfe89f2effe822cdbf3182525fe6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16978,
"upload_time": "2023-06-08T13:34:37",
"upload_time_iso_8601": "2023-06-08T13:34:37.916997Z",
"url": "https://files.pythonhosted.org/packages/c8/3b/0df9ee34d7a403311d99b28138d3e12417cb1055b1df4fdf7d5b327be74f/micromouse_api-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2db193aa7fada1f39b97fcd60c85f342f3a99102a7559e4de7de2406e0374162",
"md5": "0f61d62821a181e5f63d2566ce80b195",
"sha256": "66f140ae3281134b143a9d220c2d9c164b40c9dec41fc65fe9e109ea369e32c8"
},
"downloads": -1,
"filename": "micromouse-api-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "0f61d62821a181e5f63d2566ce80b195",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16315,
"upload_time": "2023-06-08T13:35:00",
"upload_time_iso_8601": "2023-06-08T13:35:00.726438Z",
"url": "https://files.pythonhosted.org/packages/2d/b1/93aa7fada1f39b97fcd60c85f342f3a99102a7559e4de7de2406e0374162/micromouse-api-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-08 13:35:00",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "micromouse-api"
}
JSON