bitmasher-game


Namebitmasher-game JSON
Version 5.74351224532 PyPI version JSON
download
home_pagehttps://github.com/ona-li-toki-e-jan-Epiphany-tawa-mi/BitMasher
SummaryBitMasher, a text adventure game where you act as an antivirus attempting to rid a computer of a RANSOMWARE attack.
upload_time2024-03-23 17:02:09
maintainerNone
docs_urlNone
authorona li toki e jan Epiphany tawa mi
requires_pythonNone
licenseMIT
keywords bitmasher text-adventure-based game cli game fast-paced text-game
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ```text
 ______  __________________ _______  _______  _______           _______  _______
(  ___ \ \__   __/\__   __/(       )(  ___  )(  ____ \|\     /|(  ____ \(  ____ )
| (   ) )   ) (      ) (   | () () || (   ) || (    \/| )   ( || (    \/| (    )|
| (__/ /    | |      | |   | || || || (___) || (_____ | (___) || (__    | (____)|
|  __ (     | |      | |   | |(_)| ||  ___  |(_____  )|  ___  ||  __)   |     __)
| (  \ \    | |      | |   | |   | || (   ) |      ) || (   ) || (      | (\ (
| )___) )___) (___   | |   | )   ( || )   ( |/\____) || )   ( || (____/\| ) \ \__
|/ \___/ \_______/   )_(   |/     \||/     \|\_______)|/     \|(_______/|/   \__/
```

# BitMasher

A text adventure game where you act as an antivirus attempting to rid a computer
of a RANSOMWARE attack.

## Controls

Each option you can select will be shown by a single character in paranthesis.
Typing that character and hitting ENTER will select that option.

## How to Play

You are an antivirus trying to rid a computer of a RANSOMWARE before it takes
over the system. There is a finite amount of time before the system is fully
infected.

In order to defeat it, you must find all items before you find the RANSOMWARE.
If you do not, you will not be able to EXTRACT it and you will lose.

Each system (room) contains an item, which you can move to; UP, DOWN, LEFT, AND
RIGHT. Keep in mind that the map is NOT 2D; Moving RIGHT, UP, LEFT, and DOWN
will lead to a different room than the one you started in. The map is "Spiky"
so-to-speak.

You have a SCANner to aid in figuring out which rooms contain items and which
have RANSOMWARE. Using the SCANner will reveal what the surronding rooms
contain, and the room you are currently in will be automatically SCANned for
you. But beware: SCANning takes time. Also, occasionaly a SCAN will fail and
need to be repeated.

## Configuration

There is a section at the top of the program file
`src/bitmasher_game/TextBasedGame.py` containing configuration options. All
config options bear a description detailing what they modify and what values
they accept.

## How to run

You will need Python 3 installed on your system.

BitMasher is, itself, a stand-alone Python script
`src/bitmasher_game/TextBasedGame.py`, and can be ran without installation.

If installed, run the following command(s):

```console
bitmasher
```

## Installation

BitMasher is avalible on [(CLEARNET) PyPi,](https://pypi.org/project/bitmasher-game "Bitmasher page on PyPi")
and can be installed by running the following command(s):

```console
pip install bitmasher_game
```

You can also install it with Nix from the [(CLEARNET) NUR](https://github.com/nix-community/NUR)
with the following attribute:

```nix
nur.repos.ona-li-toki-e-jan-Epiphany-tawa-mi.bitmasher
```

## How to build

You will need Python 3 and the Python build module installed on your system.
There is a `shell.nix` you can use with `nix-shell` to get them.

Run the following commands in the project directory:

```console
python3 -m build
```

The built packages will appear in `dist/`.

## Release Notes

- "Improved" lose sequence.

## Bugs

Report bugs to:<br>
https://github.com/ona-li-toki-e-jan-Epiphany-tawa-mi/BitMasher/issues

## Links

Demonstration:<br>
https://odysee.com/@ona-li-toki-e-jan-Epiphany-tawa-mi:9/BitMasher-A-fast-paced-text-based-game-born-from-my-frustration-and-pettiness:d?r=HYroMZaqrVN4gL5oSJ35gcTgt3K56r39

# Change Log

- "Improved" lose sequence.

## 4.3853256532

- Initial release ;)

MIT License

Copyright (c) 2022,2024 ona-li-toki-e-jan-Epiphany-tawa-mi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ona-li-toki-e-jan-Epiphany-tawa-mi/BitMasher",
    "name": "bitmasher-game",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "BitMasher, text-adventure-based game, cli, game, fast-paced, text-game",
    "author": "ona li toki e jan Epiphany tawa mi",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/8f/bf/9a46fa8f5e0a238905dfae7cc9a77073e0d03468e1ffde32b3b3b04375e2/bitmasher_game-5.74351224532.tar.gz",
    "platform": "Windows",
    "description": "```text\n ______  __________________ _______  _______  _______           _______  _______\n(  ___ \\ \\__   __/\\__   __/(       )(  ___  )(  ____ \\|\\     /|(  ____ \\(  ____ )\n| (   ) )   ) (      ) (   | () () || (   ) || (    \\/| )   ( || (    \\/| (    )|\n| (__/ /    | |      | |   | || || || (___) || (_____ | (___) || (__    | (____)|\n|  __ (     | |      | |   | |(_)| ||  ___  |(_____  )|  ___  ||  __)   |     __)\n| (  \\ \\    | |      | |   | |   | || (   ) |      ) || (   ) || (      | (\\ (\n| )___) )___) (___   | |   | )   ( || )   ( |/\\____) || )   ( || (____/\\| ) \\ \\__\n|/ \\___/ \\_______/   )_(   |/     \\||/     \\|\\_______)|/     \\|(_______/|/   \\__/\n```\n\n# BitMasher\n\nA text adventure game where you act as an antivirus attempting to rid a computer\nof a RANSOMWARE attack.\n\n## Controls\n\nEach option you can select will be shown by a single character in paranthesis.\nTyping that character and hitting ENTER will select that option.\n\n## How to Play\n\nYou are an antivirus trying to rid a computer of a RANSOMWARE before it takes\nover the system. There is a finite amount of time before the system is fully\ninfected.\n\nIn order to defeat it, you must find all items before you find the RANSOMWARE.\nIf you do not, you will not be able to EXTRACT it and you will lose.\n\nEach system (room) contains an item, which you can move to; UP, DOWN, LEFT, AND\nRIGHT. Keep in mind that the map is NOT 2D; Moving RIGHT, UP, LEFT, and DOWN\nwill lead to a different room than the one you started in. The map is \"Spiky\"\nso-to-speak.\n\nYou have a SCANner to aid in figuring out which rooms contain items and which\nhave RANSOMWARE. Using the SCANner will reveal what the surronding rooms\ncontain, and the room you are currently in will be automatically SCANned for\nyou. But beware: SCANning takes time. Also, occasionaly a SCAN will fail and\nneed to be repeated.\n\n## Configuration\n\nThere is a section at the top of the program file\n`src/bitmasher_game/TextBasedGame.py` containing configuration options. All\nconfig options bear a description detailing what they modify and what values\nthey accept.\n\n## How to run\n\nYou will need Python 3 installed on your system.\n\nBitMasher is, itself, a stand-alone Python script\n`src/bitmasher_game/TextBasedGame.py`, and can be ran without installation.\n\nIf installed, run the following command(s):\n\n```console\nbitmasher\n```\n\n## Installation\n\nBitMasher is avalible on [(CLEARNET) PyPi,](https://pypi.org/project/bitmasher-game \"Bitmasher page on PyPi\")\nand can be installed by running the following command(s):\n\n```console\npip install bitmasher_game\n```\n\nYou can also install it with Nix from the [(CLEARNET) NUR](https://github.com/nix-community/NUR)\nwith the following attribute:\n\n```nix\nnur.repos.ona-li-toki-e-jan-Epiphany-tawa-mi.bitmasher\n```\n\n## How to build\n\nYou will need Python 3 and the Python build module installed on your system.\nThere is a `shell.nix` you can use with `nix-shell` to get them.\n\nRun the following commands in the project directory:\n\n```console\npython3 -m build\n```\n\nThe built packages will appear in `dist/`.\n\n## Release Notes\n\n- \"Improved\" lose sequence.\n\n## Bugs\n\nReport bugs to:<br>\nhttps://github.com/ona-li-toki-e-jan-Epiphany-tawa-mi/BitMasher/issues\n\n## Links\n\nDemonstration:<br>\nhttps://odysee.com/@ona-li-toki-e-jan-Epiphany-tawa-mi:9/BitMasher-A-fast-paced-text-based-game-born-from-my-frustration-and-pettiness:d?r=HYroMZaqrVN4gL5oSJ35gcTgt3K56r39\n\n# Change Log\n\n- \"Improved\" lose sequence.\n\n## 4.3853256532\n\n- Initial release ;)\n\nMIT License\n\nCopyright (c) 2022,2024 ona-li-toki-e-jan-Epiphany-tawa-mi\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "BitMasher, a text adventure game where you act as an antivirus attempting to rid a computer of a RANSOMWARE attack.",
    "version": "5.74351224532",
    "project_urls": {
        "Download": "https://github.com/ona-li-toki-e-jan-Epiphany-tawa-mi/BitMasher/releases",
        "Homepage": "https://github.com/ona-li-toki-e-jan-Epiphany-tawa-mi/BitMasher"
    },
    "split_keywords": [
        "bitmasher",
        " text-adventure-based game",
        " cli",
        " game",
        " fast-paced",
        " text-game"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "89e75b15a0d55761d5055bca3d506b458d805932d24d41308ec4b50f5d0115cb",
                "md5": "4960962de11b51f9977d38057cc8fc72",
                "sha256": "e9a8ea929d4363ade32753362b5270b335ea84c589381704223ddd541c8e73b2"
            },
            "downloads": -1,
            "filename": "bitmasher_game-5.74351224532-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4960962de11b51f9977d38057cc8fc72",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 15478,
            "upload_time": "2024-03-23T17:02:07",
            "upload_time_iso_8601": "2024-03-23T17:02:07.652247Z",
            "url": "https://files.pythonhosted.org/packages/89/e7/5b15a0d55761d5055bca3d506b458d805932d24d41308ec4b50f5d0115cb/bitmasher_game-5.74351224532-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8fbf9a46fa8f5e0a238905dfae7cc9a77073e0d03468e1ffde32b3b3b04375e2",
                "md5": "18e7061ba0d4b0854a2bb7df235fcc65",
                "sha256": "c1057288d796c7c9200120389c120524658e3c3e800c8894575470fc432ad060"
            },
            "downloads": -1,
            "filename": "bitmasher_game-5.74351224532.tar.gz",
            "has_sig": false,
            "md5_digest": "18e7061ba0d4b0854a2bb7df235fcc65",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15436,
            "upload_time": "2024-03-23T17:02:09",
            "upload_time_iso_8601": "2024-03-23T17:02:09.265072Z",
            "url": "https://files.pythonhosted.org/packages/8f/bf/9a46fa8f5e0a238905dfae7cc9a77073e0d03468e1ffde32b3b3b04375e2/bitmasher_game-5.74351224532.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-23 17:02:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ona-li-toki-e-jan-Epiphany-tawa-mi",
    "github_project": "BitMasher",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "bitmasher-game"
}
        
Elapsed time: 0.22951s