| Name | idlegame JSON |
| Version |
2.0.1.1
JSON |
| download |
| home_page | None |
| Summary | A tiny idle game you can play right from your terminal, if you are bored at your software development job |
| upload_time | 2024-10-05 04:10:56 |
| maintainer | None |
| docs_url | None |
| author | Ben Boonstra |
| requires_python | >=3.6 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# idlegame
[](https://github.com/bboonstra/idlegame/actions/workflows/pypi.yml)
[](https://github.com/bboonstra/idlegame/actions/workflows/tests.yml)
Ever find yourself stuck at your desk during slow moments in software development? **idlegame** is here to save the day! Whether you’re waiting for a build to finish or just need a quick breather, this idle game is your perfect companion to make those downtime moments a little more fun.
## Installation
Getting started with **idlegame** is a breeze. Just whip out your terminal and run:
```bash
pip install idlegame
```
## Usage
Once it’s installed, you can jump right in by typing:
```bash
idlegame
```
## Features
- **Easy to Play**: I literally can't think of a way to make it easier. Install and run in 2 steps!
- **Casual Gameplay**: Ideal for short breaks or when you need to step away from coding.
- **Offline Play**: Even when you’re not actively playing, your nanobots are hard at work.
- **IncrediSave**: Automatic saves mean you’ll never lose progress. It’s like magic.
## How To Play
**idlegame** is a game made for two purposes. One, to entertain you at work. Two, to teach you some zsh commands.
To that end, every command in idlegame is a valid zsh command (or helper command, or real cli).
Play the game by scripting nanobots with nano. These nanobots can collect resources, defend your filetree, and more.
For example,
### Quickstart
```zsh
Logged in as: bb
bb@idlegame % uptime
Here, you'll be able to see what has happened since you last checked on the uptime of your nanobots.
You can create a nanobot with `nano`, but it requires a nanocore. Here's one to get you started.
Recieved: 1 basic nano core
bb@idlegame % nano --name mine&defend -y
Write the logic for your nanobot (type 'done' on a new line to finish):
idle mine
on invasion defend
done
Nanobot 'mine&defend' created!
bb@idlegame % ls
Name Type Idle Action Event Actions Current Action
----------------------------------------------------------------------------------------------------
mine&defend Normal Mine On invasion: defend Performing idle action: mine
----------------------------------------------------------------------------------------------------
bb@idlegame %
```
The zsh above shows an efficient way to get started. Claim a nano core, and use it to create a Nanobot that mines for gold. However, if someone invades you, the Nanobot will help defend. This is a very useful all-purpose bot.
## I'm stuck
```zsh
man
```
## Contributing
Got ideas or feedback? We’d love to hear from you! Feel free to submit a pull request or open an issue on the GitHub repo. Your thoughts can make **idlegame** even better :>
## License
This project is licensed under the MIT License. Check out the [LICENSE](LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "idlegame",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Ben Boonstra",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/5e/d3/0df102defbd07ac84021b437c0267b47d2e359f56deee7128cffb9fefa72/idlegame-2.0.1.1.tar.gz",
"platform": null,
"description": "# idlegame\n\n[](https://github.com/bboonstra/idlegame/actions/workflows/pypi.yml)\n[](https://github.com/bboonstra/idlegame/actions/workflows/tests.yml)\n\nEver find yourself stuck at your desk during slow moments in software development? **idlegame** is here to save the day! Whether you\u2019re waiting for a build to finish or just need a quick breather, this idle game is your perfect companion to make those downtime moments a little more fun.\n\n## Installation\n\nGetting started with **idlegame** is a breeze. Just whip out your terminal and run:\n\n```bash\npip install idlegame\n```\n\n## Usage\n\nOnce it\u2019s installed, you can jump right in by typing:\n\n```bash\nidlegame\n```\n\n## Features\n\n- **Easy to Play**: I literally can't think of a way to make it easier. Install and run in 2 steps!\n- **Casual Gameplay**: Ideal for short breaks or when you need to step away from coding.\n- **Offline Play**: Even when you\u2019re not actively playing, your nanobots are hard at work.\n- **IncrediSave**: Automatic saves mean you\u2019ll never lose progress. It\u2019s like magic.\n\n## How To Play\n\n**idlegame** is a game made for two purposes. One, to entertain you at work. Two, to teach you some zsh commands.\nTo that end, every command in idlegame is a valid zsh command (or helper command, or real cli).\nPlay the game by scripting nanobots with nano. These nanobots can collect resources, defend your filetree, and more.\n\nFor example,\n\n### Quickstart\n\n```zsh\nLogged in as: bb\nbb@idlegame % uptime\nHere, you'll be able to see what has happened since you last checked on the uptime of your nanobots.\nYou can create a nanobot with `nano`, but it requires a nanocore. Here's one to get you started.\nRecieved: 1 basic nano core\nbb@idlegame % nano --name mine&defend -y\nWrite the logic for your nanobot (type 'done' on a new line to finish):\nidle mine\non invasion defend\ndone\nNanobot 'mine&defend' created!\nbb@idlegame % ls\nName Type Idle Action Event Actions Current Action \n----------------------------------------------------------------------------------------------------\nmine&defend Normal Mine On invasion: defend Performing idle action: mine \n----------------------------------------------------------------------------------------------------\nbb@idlegame % \n```\n\nThe zsh above shows an efficient way to get started. Claim a nano core, and use it to create a Nanobot that mines for gold. However, if someone invades you, the Nanobot will help defend. This is a very useful all-purpose bot.\n\n## I'm stuck\n\n```zsh\nman\n```\n\n## Contributing\n\nGot ideas or feedback? We\u2019d love to hear from you! Feel free to submit a pull request or open an issue on the GitHub repo. Your thoughts can make **idlegame** even better :>\n\n## License\n\nThis project is licensed under the MIT License. Check out the [LICENSE](LICENSE) file for more details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tiny idle game you can play right from your terminal, if you are bored at your software development job",
"version": "2.0.1.1",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c88fab68f446a655603784c5c7e79a899cde9ea9c74bc4e8eb81c94977f53c8f",
"md5": "65abdc13ab7c7049226bf76e2df63445",
"sha256": "5c0af469e5032d0a8c63015b19a83c6e123b203f2095ef0007e6487feedafbf8"
},
"downloads": -1,
"filename": "idlegame-2.0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65abdc13ab7c7049226bf76e2df63445",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 23918,
"upload_time": "2024-10-05T04:10:55",
"upload_time_iso_8601": "2024-10-05T04:10:55.179332Z",
"url": "https://files.pythonhosted.org/packages/c8/8f/ab68f446a655603784c5c7e79a899cde9ea9c74bc4e8eb81c94977f53c8f/idlegame-2.0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5ed30df102defbd07ac84021b437c0267b47d2e359f56deee7128cffb9fefa72",
"md5": "84ab15631f44c0a4681f98037c5473d2",
"sha256": "f89be650e444034a489dd7b71e3a8ff6b923ce741ef73f9c86b1d2887bb6f9b3"
},
"downloads": -1,
"filename": "idlegame-2.0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "84ab15631f44c0a4681f98037c5473d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 21703,
"upload_time": "2024-10-05T04:10:56",
"upload_time_iso_8601": "2024-10-05T04:10:56.714570Z",
"url": "https://files.pythonhosted.org/packages/5e/d3/0df102defbd07ac84021b437c0267b47d2e359f56deee7128cffb9fefa72/idlegame-2.0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-05 04:10:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "idlegame"
}
