{"id":27998456,"url":"https://github.com/mattyhakin/dice-roller","last_synced_at":"2025-05-08T22:53:25.123Z","repository":{"id":291970588,"uuid":"979375997","full_name":"mattyhakin/dice-roller","owner":"mattyhakin","description":"A lightweight and flexible Python tool for simulating dice rolls, perfect for tabletop games, RPGs, and probability testing.","archived":false,"fork":false,"pushed_at":"2025-05-07T14:20:20.000Z","size":67,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-08T22:53:21.667Z","etag":null,"topics":["cli","dice","dice-roller","gaming","python","rpg","simulation","tabletop","tool","utlities"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mattyhakin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2025-05-07T12:20:25.000Z","updated_at":"2025-05-07T14:20:23.000Z","dependencies_parsed_at":"2025-05-07T13:44:54.248Z","dependency_job_id":"66111270-c785-4775-b443-c7a6aca73b3c","html_url":"https://github.com/mattyhakin/dice-roller","commit_stats":null,"previous_names":["mattyhakin/dice-roller"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattyhakin%2Fdice-roller","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattyhakin%2Fdice-roller/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattyhakin%2Fdice-roller/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattyhakin%2Fdice-roller/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattyhakin","download_url":"https://codeload.github.com/mattyhakin/dice-roller/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253160821,"owners_count":21863624,"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","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","dice","dice-roller","gaming","python","rpg","simulation","tabletop","tool","utlities"],"created_at":"2025-05-08T22:53:24.521Z","updated_at":"2025-05-08T22:53:25.111Z","avatar_url":"https://github.com/mattyhakin.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/mattyhakin/dice-roller/blob/main/dice-roller-header.png?raw=true\" alt=\"Dice Roller\"/\u003e\n\n# 🎲 Dice Roller\n\n[![Build Status](https://img.shields.io/github/actions/workflow/status/mattyhakin/dice-roller/test.yml?branch=main\u0026label=tests)](https://github.com/mattyhakin/dice-roller/actions/workflows/test.yml)\n[![Version](https://img.shields.io/github/v/release/mattyhakin/dice-roller?label=version)](https://github.com/mattyhakin/dice-roller/releases)\n[![License](https://img.shields.io/github/license/mattyhakin/dice-roller)](https://github.com/mattyhakin/dice-roller/blob/main/LICENSE)\n[![Python](https://img.shields.io/badge/python-3.6%2B-blue)](https://www.python.org/)\n[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://pre-commit.com/)\n[![Commitizen Friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](https://commitizen-tools.github.io/commitizen/)\n\nA lightweight and flexible Python tool for simulating dice rolls. Perfect for tabletop RPGs, board games, and quick probability testing.\n\n...\n\n(Hint: this includes the previous README plus the badges)\n\n\n![Test Status](https://github.com/mattyhakin/dice-roller/actions/workflows/test.yml/badge.svg)\n\nA lightweight and flexible Python tool for simulating dice rolls. Perfect for tabletop RPGs, board games, and quick probability testing.\n\n## 🔧 Features\n\n- Roll any standard or custom dice using NdX+M notation (e.g., d6, d20, 3d8+2)\n- Uniform number-based ASCII output for all dice types\n- CLI tool with argparse support\n- Ready for packaging and publishing on PyPI\n- Automatic testing via GitHub Actions\n\n## 📦 Installation\n\nClone the repository:\n\n```bash\ngit clone https://github.com/mattyhakin/dice-roller.git\ncd dice-roller\n```\n\n(Optional) Create a virtual environment:\n\n```bash\npython -m venv venv\nsource venv/bin/activate  # or venv\\Scripts\\activate on Windows\n```\n\nInstall locally:\n```bash\npip install .\n```\n\n## 🚀 Usage\n\nRun from the command line:\n\n```bash\ndice-roller 3d6+1\n```\n\nExample output:\n```\n~~~~~~~~~~~~~~~ RESULTS ~~~~~~~~~~~~~~~\n┌─────┐ ┌─────┐ ┌─────┐\n│  2  │ │  5  │ │  6  │\n└─────┘ └─────┘ └─────┘\nModifier: +1\nTotal: 13 +1 = 14\n```\n\n## 📁 Project Structure\n\n```\ndice-roller/\n├── dice_roller.py\n├── tests/\n│   └── test_dice_roller.py\n├── setup.py\n├── pyproject.toml\n├── README.md\n├── LICENSE\n└── .github/\n    └── workflows/\n        ├── publish.yml\n        └── test.yml\n```\n\n## ✅ To Do\n\n- [x] Add support for flexible dice types\n- [x] Uniform visual display for all rolls\n- [x] CLI interface with argparse\n- [x] PyPI publishing automation\n- [x] Automated testing with GitHub Actions\n- [ ] Add extended CLI flags (e.g. verbose, JSON output)\n- [ ] Internationalization/localization support\n\n## 🤝 Contributing\n\nPull requests are welcome! For major changes, open an issue to discuss what you'd like to change.\n\n## 📄 License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattyhakin%2Fdice-roller","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattyhakin%2Fdice-roller","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattyhakin%2Fdice-roller/lists"}