| Name | amazeme JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | https://github.com/zabojeb/amazeme |
| Summary | CLI utilite for generating and displaying mazes in the terminal |
| upload_time | 2024-08-21 18:59:13 |
| maintainer | None |
| docs_url | None |
| author | zabojeb |
| requires_python | >=3.6 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">
aMAZEme
</h1>
<p align="center">
<a href="https://github.com/zabojeb/amazeme/actions?query=workflow:%22Upload+Python+Package%22">
<img alt="Upload Python Package" src="https://github.com/zabojeb/amazeme/workflows/Upload%20Python%20Package/badge.svg" />
</a>
<a href="https://github.com/zabojeb/amazeme/releases/">
<img alt="GitHub tag" src="https://img.shields.io/github/tag/zabojeb/amazeme?include_prereleases=&sort=semver&color=blue" />
</a>
<a href="#license">
<img alt="License" src="https://img.shields.io/badge/License-MIT-blue" />
</a>
</p>
<p align="center">
Maze generation tool that will amaze you!
</p>
`amazeme` is a terminal-based maze generator and viewer implemented in Python using the `curses` library. This tool allows users to visualize mazes directly in the terminal, customize the appearance with various options, and even provide their own maze generation algorithms.
## Features
- **Custom Algorithms**: Ability to load and use custom maze generation algorithms from external Python files.
- **Customizable Appearance**: Adjust wall and background colors, use different characters for walls and spaces.
- **Solid Mode**: Option to double the wall and space characters for a denser display.
- **Shuffle Mode**: Randomize the characters used for walls and spaces.
- **Real-Time Updates**: Option to continuously refresh the maze display.
## Installation
To install `amazeme`, you need to have Python 3 and `pip` installed.
You can then install `amazeme` via **pip** using the following command:
```bash
pip install amazeme
```
You can also install it via **pipx**:
```bash
pipx install amazeme
```
## Usage
After installation, you can run `amazeme` from the terminal with various options to customize the maze display.
To display a maze with default settings:
```bash
amazeme
```
### Options
- `-c`, `--wall-color`:
Set the color of the walls. You can use color names (e.g., `red`, `blue`) or integer color codes. Use `-1` for default terminal foreground.
- `-b`, `--bg-color`:
Set the background color. Use color names or integer color codes. Use `-1` for default terminal background.
- `--solid-mode`:
Enable solid mode to double the characters used for walls and spaces.
- `--wall`:
Specify the string for walls (e.g., `#`, `█`, `><`). Defaults to `███`.
- `--space`:
Specify the character for spaces (e.g., `.`, ` `). Defaults to a single space.
- `--shuffle`:
Randomly shuffle the wall and space characters during rendering.
- `--live`:
Enable live updates of the maze display. The maze will continuously refresh.
- `--rate`:
Framerate to refresh maze. Works only with `--live`.
- `--source`:
Provide the path to a `.py` file containing a custom `generate_maze(width, height)` function. This allows you to use your own maze generation algorithm.
### Example Commands
- Display a maze with red walls and black background:
```bash
amazeme -c red -b black
```
- Use custom characters for walls and spaces with solid mode:
```bash
amazeme --wall "###" --space "." --solid-mode
```
- Enable live updates and shuffle 123 characters:
```bash
amazeme --live --shuffle --wall "123"
```
- Use a custom maze generation algorithm from `custom_maze.py`:
```bash
amazeme --source /path/to/custom_maze.py
```
## Custom Maze Generation
To provide your own maze generation algorithm, create a Python file with a function `generate_maze(width, height)`. This function should return a 2D list (list of lists) where each element is `0` for spaces and `1` for walls.
Example of a custom maze generation file (`custom_maze.py`):
```python
def generate_maze(width, height):
""" My incredible maze generation function """
return [[1 if (x + y) % 2 == 0 else 0 for x in range(width)] for y in range(height)]
```
There is also a bunch of different generators in `generators` folder in GitHub repository of project.
Feel free to contribute and add your own generators!
## Contributing
Contributions are welcome! If you have suggestions or improvements, please fork the repository and submit a pull request.
1. Fork the repository.
2. Create a feature branch (`git checkout -b feature/YourFeature`).
3. Commit your changes (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
<p align="center">
Made with ❤️ by <a href="https://github.com/zabojeb">zabojeb</a>
</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/zabojeb/amazeme",
"name": "amazeme",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "zabojeb",
"author_email": "zabojeb@bk.ru",
"download_url": "https://files.pythonhosted.org/packages/14/1b/8face2825f7418c3d8662b382826f92e76f6e6451692c71b0c17d10ef59e/amazeme-1.0.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n aMAZEme\n</h1>\n<p align=\"center\">\n <a href=\"https://github.com/zabojeb/amazeme/actions?query=workflow:%22Upload+Python+Package%22\">\n <img alt=\"Upload Python Package\" src=\"https://github.com/zabojeb/amazeme/workflows/Upload%20Python%20Package/badge.svg\" />\n </a>\n <a href=\"https://github.com/zabojeb/amazeme/releases/\">\n <img alt=\"GitHub tag\" src=\"https://img.shields.io/github/tag/zabojeb/amazeme?include_prereleases=&sort=semver&color=blue\" />\n </a>\n <a href=\"#license\">\n <img alt=\"License\" src=\"https://img.shields.io/badge/License-MIT-blue\" />\n </a>\n</p>\n<p align=\"center\">\n Maze generation tool that will amaze you!\n</p>\n\n\n\n`amazeme` is a terminal-based maze generator and viewer implemented in Python using the `curses` library. This tool allows users to visualize mazes directly in the terminal, customize the appearance with various options, and even provide their own maze generation algorithms.\n\n## Features\n\n- **Custom Algorithms**: Ability to load and use custom maze generation algorithms from external Python files.\n- **Customizable Appearance**: Adjust wall and background colors, use different characters for walls and spaces.\n- **Solid Mode**: Option to double the wall and space characters for a denser display.\n- **Shuffle Mode**: Randomize the characters used for walls and spaces.\n- **Real-Time Updates**: Option to continuously refresh the maze display.\n\n## Installation\n\nTo install `amazeme`, you need to have Python 3 and `pip` installed. \n\nYou can then install `amazeme` via **pip** using the following command:\n\n```bash\npip install amazeme\n```\n\nYou can also install it via **pipx**:\n\n```bash\npipx install amazeme\n```\n\n## Usage\n\nAfter installation, you can run `amazeme` from the terminal with various options to customize the maze display.\n\nTo display a maze with default settings:\n\n```bash\namazeme\n```\n\n### Options\n\n- `-c`, `--wall-color`:\n Set the color of the walls. You can use color names (e.g., `red`, `blue`) or integer color codes. Use `-1` for default terminal foreground.\n\n- `-b`, `--bg-color`:\n Set the background color. Use color names or integer color codes. Use `-1` for default terminal background.\n\n- `--solid-mode`:\n Enable solid mode to double the characters used for walls and spaces.\n\n- `--wall`:\n Specify the string for walls (e.g., `#`, `\u2588`, `><`). Defaults to `\u2588\u2588\u2588`.\n\n- `--space`:\n Specify the character for spaces (e.g., `.`, ` `). Defaults to a single space.\n\n- `--shuffle`:\n Randomly shuffle the wall and space characters during rendering.\n\n- `--live`:\n Enable live updates of the maze display. The maze will continuously refresh.\n\n- `--rate`:\n Framerate to refresh maze. Works only with `--live`.\n \n- `--source`:\n Provide the path to a `.py` file containing a custom `generate_maze(width, height)` function. This allows you to use your own maze generation algorithm.\n\n### Example Commands\n\n- Display a maze with red walls and black background:\n\n ```bash\n amazeme -c red -b black\n ```\n\n- Use custom characters for walls and spaces with solid mode:\n\n ```bash\n amazeme --wall \"###\" --space \".\" --solid-mode\n ```\n\n- Enable live updates and shuffle 123 characters:\n\n ```bash\n amazeme --live --shuffle --wall \"123\"\n ```\n\n- Use a custom maze generation algorithm from `custom_maze.py`:\n\n ```bash\n amazeme --source /path/to/custom_maze.py\n ```\n\n## Custom Maze Generation\n\nTo provide your own maze generation algorithm, create a Python file with a function `generate_maze(width, height)`. This function should return a 2D list (list of lists) where each element is `0` for spaces and `1` for walls.\n\nExample of a custom maze generation file (`custom_maze.py`):\n\n```python\ndef generate_maze(width, height):\n \"\"\" My incredible maze generation function \"\"\"\n return [[1 if (x + y) % 2 == 0 else 0 for x in range(width)] for y in range(height)]\n```\n\nThere is also a bunch of different generators in `generators` folder in GitHub repository of project.\n\nFeel free to contribute and add your own generators!\n\n## Contributing\n\nContributions are welcome! If you have suggestions or improvements, please fork the repository and submit a pull request.\n\n1. Fork the repository.\n2. Create a feature branch (`git checkout -b feature/YourFeature`).\n3. Commit your changes (`git commit -am 'Add some feature'`).\n4. Push to the branch (`git push origin feature/YourFeature`).\n5. Open a pull request.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n---\n\n<p align=\"center\">\n Made with \u2764\ufe0f by <a href=\"https://github.com/zabojeb\">zabojeb</a>\n</p>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI utilite for generating and displaying mazes in the terminal",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/zabojeb/amazeme"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c125c1116eb694569a8f315934ceac0c60dfd3588151e1d9d2cd00b9e21750ad",
"md5": "0b3ff33fbaaf3779340f8b5dcd7cac91",
"sha256": "10be5a75168bc53f591918dd8284239febce4c50292da7d28c2ad65ff1480c93"
},
"downloads": -1,
"filename": "amazeme-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b3ff33fbaaf3779340f8b5dcd7cac91",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7112,
"upload_time": "2024-08-21T18:59:12",
"upload_time_iso_8601": "2024-08-21T18:59:12.226589Z",
"url": "https://files.pythonhosted.org/packages/c1/25/c1116eb694569a8f315934ceac0c60dfd3588151e1d9d2cd00b9e21750ad/amazeme-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "141b8face2825f7418c3d8662b382826f92e76f6e6451692c71b0c17d10ef59e",
"md5": "8749a826b15160df885dfbbf3c850e50",
"sha256": "c2363fee52bcfa4128780665833b0538a4673d6997cb9bfa1d0bcc4d4dddb0d4"
},
"downloads": -1,
"filename": "amazeme-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8749a826b15160df885dfbbf3c850e50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6978,
"upload_time": "2024-08-21T18:59:13",
"upload_time_iso_8601": "2024-08-21T18:59:13.691408Z",
"url": "https://files.pythonhosted.org/packages/14/1b/8face2825f7418c3d8662b382826f92e76f6e6451692c71b0c17d10ef59e/amazeme-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 18:59:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zabojeb",
"github_project": "amazeme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "amazeme"
}
