> _______
> / _____ \
> | | | |
> | | | |
> | | | | _ __ ___ __ _ _ _ ___
> | | | | | '__/ _ \ / _` | | | |/ _ \
> | |_____| | | | | (_) | (_| | |_| | __/
> \______\_\ |_| \___/ \__, |\__,_|\___|
> __/ |
> |___/
ASCII-Art generated by https://www.ascii-art-generator.org/
# Qrogue v0.7.0 #
Qrogue is a modernized Quantum Computing take of the classical game
[Rogue](https://en.wikipedia.org/wiki/Rogue_%28video_game%29).
You will play as a student whose dream is to travel through the galaxy.
As they hear about "Mission Quniverse" they immediately apply for its
training program to be able to join this fascinating Quantum Computing
powered universe exploration mission.
## Table of Contents ##
- Installation
- Dependencies
- Linux
- Windows
- Notes
- How to play - Controls
- Outlook
## Installation ##
### Dependencies ###
- py_cui 0.1.4
- qiskit 0.34.2
- numpy 1.20.3
- antlr4-python3-runtime 4.10
However, these dependencies are installed automatically if you install Qrogue via pip.
### Linux/macOS ###
#### Prerequisites ####
- Python 3.8
- pip
For Linux/macOS you simply have to run
```bash
pip install qrogue
```
to install Qrogue in your current Python environment.
Afterwards you can launch the game simply by executing `qrogue` in the Python environment you installed Qrogue in.
### Windows ###
#### Prerequisites ####
Same as for Linux/macOS
## Notes ##
- `py_cui.errors.PyCUIOutOfBoundsError`
Should you ever encounter this error
when starting the game please try to maximize the console you
use for playing. This is because currently there is no automatic
font size adaption so depending on your console settings a
minimum width and height is required. Alternatively or if
maximizing doesn't help you can also lower the font size of the
console.
- newer Python versions
Usually also Python 3.9 should perfectly work for
playing Qrogue but testing is currently done for Python 3.8 so
there is no official support yet for other versions. The same
is true if you decide to manually install the dependencies; newer
version will likely work but are not recommended.
Python 3.10 is not yet supported due to changes in import locations.
## How to play - Controls ##
- Navigate in menus: Arrow Keys, wasd
- Move in game world: Arrow Keys, wasd
- Scroll in popup: Arrow Keys, wasd
- Close popup: Space, Enter
- Reopen last popup: H
- Select answer in question popup: horizontal Arrow Keys, ad
- Confirm selection (also in question popup): Space, Enter
- Cancel/back: Shift+A, Shift+Left, Backspace
- Pause: P, Tab
- Situational
- shortcut keys: 0-9
-
- Debug Keys (not for use in normal play through!)
- Print screen: CTRL+P
- Force re-render: CTRL+R
## Feedback ##
We'd be very happy if you share any feedback with us, regardless whether you liked the game or not.
Just send it via Email to michael.artner@jku.at with the subject "Qrogue Feedback".
It would also be nice if you could add your user-data folder ("qrogue/QrogueData", for normal installations it can be found in your virtual environment's packages) with the log files. Thanks!
If you find a typo: In the title of the popup window you should find something like "{@abc}" where abc is the message id.
Please do tell us the message id so we have an easier time fixing it. Thanks!
## Outlook ##
Raw data
{
"_id": null,
"home_page": "https://github.com/7Magic7Mike7/Qrogue",
"name": "qrogue",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Quantum Computing,Gamification,Video Game,PyCUI",
"author": "Michael Artner",
"author_email": "michael.artner@jku.at",
"download_url": "https://files.pythonhosted.org/packages/7b/85/b68f099aa2c55622b9533b9e0c66fe93df40ddcc67356330cb4219c54254/qrogue-0.7.0.5.tar.gz",
"platform": null,
"description": "> _______ \n> / _____ \\ \n> | | | | \n> | | | | \n> | | | | _ __ ___ __ _ _ _ ___ \n> | | | | | '__/ _ \\ / _` | | | |/ _ \\\n> | |_____| | | | | (_) | (_| | |_| | __/ \n> \\______\\_\\ |_| \\___/ \\__, |\\__,_|\\___| \n> __/ | \n> |___/ \nASCII-Art generated by https://www.ascii-art-generator.org/\n\n# Qrogue v0.7.0 #\n\nQrogue is a modernized Quantum Computing take of the classical game \n[Rogue](https://en.wikipedia.org/wiki/Rogue_%28video_game%29). \n\nYou will play as a student whose dream is to travel through the galaxy. \nAs they hear about \"Mission Quniverse\" they immediately apply for its \ntraining program to be able to join this fascinating Quantum Computing \npowered universe exploration mission.\n\n\n## Table of Contents ##\n- Installation\n - Dependencies\n - Linux\n - Windows\n- Notes\n- How to play - Controls\n- Outlook\n\n## Installation ##\n\n\n### Dependencies ###\n- py_cui 0.1.4\n- qiskit 0.34.2\n- numpy 1.20.3\n- antlr4-python3-runtime 4.10\n\nHowever, these dependencies are installed automatically if you install Qrogue via pip.\n\n### Linux/macOS ###\n\n#### Prerequisites ####\n\n- Python 3.8\n- pip\n\nFor Linux/macOS you simply have to run \n```bash\npip install qrogue\n```\nto install Qrogue in your current Python environment. \n\nAfterwards you can launch the game simply by executing `qrogue` in the Python environment you installed Qrogue in.\n\n### Windows ###\n\n#### Prerequisites ####\n\nSame as for Linux/macOS\n\n## Notes ##\n\n- `py_cui.errors.PyCUIOutOfBoundsError` \n\nShould you ever encounter this error\nwhen starting the game please try to maximize the console you \nuse for playing. This is because currently there is no automatic \nfont size adaption so depending on your console settings a \nminimum width and height is required. Alternatively or if \nmaximizing doesn't help you can also lower the font size of the \nconsole.\n\n- newer Python versions\n\nUsually also Python 3.9 should perfectly work for \nplaying Qrogue but testing is currently done for Python 3.8 so \nthere is no official support yet for other versions. The same \nis true if you decide to manually install the dependencies; newer \nversion will likely work but are not recommended.\nPython 3.10 is not yet supported due to changes in import locations.\n\n## How to play - Controls ##\n- Navigate in menus: Arrow Keys, wasd\n- Move in game world: Arrow Keys, wasd\n- Scroll in popup: Arrow Keys, wasd\n- Close popup: Space, Enter\n- Reopen last popup: H\n- Select answer in question popup: horizontal Arrow Keys, ad\n- Confirm selection (also in question popup): Space, Enter\n- Cancel/back: Shift+A, Shift+Left, Backspace\n- Pause: P, Tab\n- Situational \n - shortcut keys: 0-9\n - \n- Debug Keys (not for use in normal play through!)\n - Print screen: CTRL+P\n - Force re-render: CTRL+R \n \n## Feedback ##\nWe'd be very happy if you share any feedback with us, regardless whether you liked the game or not.\nJust send it via Email to michael.artner@jku.at with the subject \"Qrogue Feedback\". \nIt would also be nice if you could add your user-data folder (\"qrogue/QrogueData\", for normal installations it can be found in your virtual environment's packages) with the log files. Thanks!\n\nIf you find a typo: In the title of the popup window you should find something like \"{@abc}\" where abc is the message id. \nPlease do tell us the message id so we have an easier time fixing it. Thanks!\n\n## Outlook ##",
"bugtrack_url": null,
"license": "MIT",
"summary": "QRogue is a modernized Quantum Computing take of the classical game Rogue.",
"version": "0.7.0.5",
"project_urls": {
"Download": "https://github.com/7Magic7Mike7/Qrogue/releases/tag/0.7.0.5",
"Homepage": "https://github.com/7Magic7Mike7/Qrogue"
},
"split_keywords": [
"quantum computing",
"gamification",
"video game",
"pycui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b85b68f099aa2c55622b9533b9e0c66fe93df40ddcc67356330cb4219c54254",
"md5": "1d9f33ea8cd456a3535485eecd64068d",
"sha256": "c708168fae949fc7b4d4429000690ccba35c63a0b62484e604af451d594d7242"
},
"downloads": -1,
"filename": "qrogue-0.7.0.5.tar.gz",
"has_sig": false,
"md5_digest": "1d9f33ea8cd456a3535485eecd64068d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 259858,
"upload_time": "2023-11-14T15:47:32",
"upload_time_iso_8601": "2023-11-14T15:47:32.243977Z",
"url": "https://files.pythonhosted.org/packages/7b/85/b68f099aa2c55622b9533b9e0c66fe93df40ddcc67356330cb4219c54254/qrogue-0.7.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-14 15:47:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "7Magic7Mike7",
"github_project": "Qrogue",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "qrogue"
}
JSON
