{"id":34100352,"url":"https://github.com/zabojeb/amazeme","last_synced_at":"2025-12-14T16:55:23.785Z","repository":{"id":254152865,"uuid":"845606406","full_name":"zabojeb/amazeme","owner":"zabojeb","description":"CLI tool for generating and displaying mazes in the terminal","archived":false,"fork":false,"pushed_at":"2024-08-21T18:58:35.000Z","size":103,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-18T10:59:39.143Z","etag":null,"topics":["cli","maze","pypi-package","terminal"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/amazeme/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zabojeb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-21T15:12:21.000Z","updated_at":"2025-04-05T14:00:04.000Z","dependencies_parsed_at":"2024-08-21T19:09:20.957Z","dependency_job_id":null,"html_url":"https://github.com/zabojeb/amazeme","commit_stats":null,"previous_names":["zabojeb/amazeme"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/zabojeb/amazeme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zabojeb%2Famazeme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zabojeb%2Famazeme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zabojeb%2Famazeme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zabojeb%2Famazeme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zabojeb","download_url":"https://codeload.github.com/zabojeb/amazeme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zabojeb%2Famazeme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27731894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-14T02:00:11.348Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","maze","pypi-package","terminal"],"created_at":"2025-12-14T16:55:23.246Z","updated_at":"2025-12-14T16:55:23.779Z","avatar_url":"https://github.com/zabojeb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\r\n  aMAZEme\r\n\u003c/h1\u003e\r\n\u003cp align=\"center\"\u003e\r\n  \u003ca href=\"https://github.com/zabojeb/amazeme/actions?query=workflow:%22Upload+Python+Package%22\"\u003e\r\n    \u003cimg alt=\"Upload Python Package\" src=\"https://github.com/zabojeb/amazeme/workflows/Upload%20Python%20Package/badge.svg\" /\u003e\r\n  \u003c/a\u003e\r\n  \u003ca href=\"https://github.com/zabojeb/amazeme/releases/\"\u003e\r\n    \u003cimg alt=\"GitHub tag\" src=\"https://img.shields.io/github/tag/zabojeb/amazeme?include_prereleases=\u0026sort=semver\u0026color=blue\" /\u003e\r\n  \u003c/a\u003e\r\n  \u003ca href=\"#license\"\u003e\r\n    \u003cimg alt=\"License\" src=\"https://img.shields.io/badge/License-MIT-blue\" /\u003e\r\n  \u003c/a\u003e\r\n\u003c/p\u003e\r\n\u003cp align=\"center\"\u003e\r\n  Maze generation tool that will amaze you!\r\n\u003c/p\u003e\r\n\r\n![demo](/assets/demo.png)\r\n\r\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.\r\n\r\n## Features\r\n\r\n- **Custom Algorithms**: Ability to load and use custom maze generation algorithms from external Python files.\r\n- **Customizable Appearance**: Adjust wall and background colors, use different characters for walls and spaces.\r\n- **Solid Mode**: Option to double the wall and space characters for a denser display.\r\n- **Shuffle Mode**: Randomize the characters used for walls and spaces.\r\n- **Real-Time Updates**: Option to continuously refresh the maze display.\r\n\r\n## Installation\r\n\r\nTo install `amazeme`, you need to have Python 3 and `pip` installed. \r\n\r\nYou can then install `amazeme` via **pip** using the following command:\r\n\r\n```bash\r\npip install amazeme\r\n```\r\n\r\nYou can also install it via **pipx**:\r\n\r\n```bash\r\npipx install amazeme\r\n```\r\n\r\n## Usage\r\n\r\nAfter installation, you can run `amazeme` from the terminal with various options to customize the maze display.\r\n\r\nTo display a maze with default settings:\r\n\r\n```bash\r\namazeme\r\n```\r\n\r\n### Options\r\n\r\n- `-c`, `--wall-color`:\r\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.\r\n\r\n- `-b`, `--bg-color`:\r\n  Set the background color. Use color names or integer color codes. Use `-1` for default terminal background.\r\n\r\n- `--solid-mode`:\r\n  Enable solid mode to double the characters used for walls and spaces.\r\n\r\n- `--wall`:\r\n  Specify the string for walls (e.g., `#`, `█`, `\u003e\u003c`). Defaults to `███`.\r\n\r\n- `--space`:\r\n  Specify the character for spaces (e.g., `.`, ` `). Defaults to a single space.\r\n\r\n- `--shuffle`:\r\n  Randomly shuffle the wall and space characters during rendering.\r\n\r\n- `--live`:\r\n  Enable live updates of the maze display. The maze will continuously refresh.\r\n\r\n- `--rate`:\r\n  Framerate to refresh maze. Works only with `--live`.\r\n  \r\n- `--source`:\r\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.\r\n\r\n### Example Commands\r\n\r\n- Display a maze with red walls and black background:\r\n\r\n  ```bash\r\n  amazeme -c red -b black\r\n  ```\r\n\r\n- Use custom characters for walls and spaces with solid mode:\r\n\r\n  ```bash\r\n  amazeme --wall \"###\" --space \".\" --solid-mode\r\n  ```\r\n\r\n- Enable live updates and shuffle 123 characters:\r\n\r\n  ```bash\r\n  amazeme --live --shuffle --wall \"123\"\r\n  ```\r\n\r\n- Use a custom maze generation algorithm from `custom_maze.py`:\r\n\r\n  ```bash\r\n  amazeme --source /path/to/custom_maze.py\r\n  ```\r\n\r\n## Custom Maze Generation\r\n\r\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.\r\n\r\nExample of a custom maze generation file (`custom_maze.py`):\r\n\r\n```python\r\ndef generate_maze(width, height):\r\n    \"\"\" My incredible maze generation function \"\"\"\r\n    return [[1 if (x + y) % 2 == 0 else 0 for x in range(width)] for y in range(height)]\r\n```\r\n\r\nThere is also a bunch of different generators in `generators` folder in GitHub repository of project.\r\n\r\nFeel free to contribute and add your own generators!\r\n\r\n## Contributing\r\n\r\nContributions are welcome! If you have suggestions or improvements, please fork the repository and submit a pull request.\r\n\r\n1. Fork the repository.\r\n2. Create a feature branch (`git checkout -b feature/YourFeature`).\r\n3. Commit your changes (`git commit -am 'Add some feature'`).\r\n4. Push to the branch (`git push origin feature/YourFeature`).\r\n5. Open a pull request.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n---\r\n\r\n\u003cp align=\"center\"\u003e\r\n  Made with ❤️ by \u003ca href=\"https://github.com/zabojeb\"\u003ezabojeb\u003c/a\u003e\r\n\u003c/p\u003e\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzabojeb%2Famazeme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzabojeb%2Famazeme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzabojeb%2Famazeme/lists"}