pokete


Namepokete JSON
Version 0.10.0rc4 PyPI version JSON
download
home_pageNone
SummaryA terminal based Pokemon like game
upload_time2025-07-26 22:40:41
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseGPL-3.0-only
keywords game ascii
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Wiki](https://github.com/lxgr-linux/pokete/actions/workflows/main.yml/badge.svg)](https://github.com/lxgr-linux/pokete/actions/workflows/main.yml)
[![Code-Validation](https://github.com/lxgr-linux/pokete/actions/workflows/main_validate.yml/badge.svg)](https://github.com/lxgr-linux/pokete/actions/workflows/main_validate.yml)
![License](https://img.shields.io/github/license/lxgr-linux/pokete)
![AUR version](https://img.shields.io/aur/version/pokete-git)
<br>
![Open Issues](https://img.shields.io/github/issues/lxgr-linux/pokete)
![Open pull requests](https://img.shields.io/github/issues-pr/lxgr-linux/pokete)
![commit activity](https://img.shields.io/github/commit-activity/m/lxgr-linux/pokete)
![commits since last release](https://img.shields.io/github/commits-since/lxgr-linux/pokete/latest/master?include_prereleases)
![GitHub contributors](https://img.shields.io/github/contributors/lxgr-linux/pokete)

# Pokete -- Grey Edition

![Example](assets/ss/ss01.png)

[See more example pics](assets/pics.md)

## What is it?

Pokete is a small terminal based game in the style of a very popular and old game by Gamefreak.

## Installation

```shell
pip install pokete
```

You can also install it from the AUR:

```shell
$ buildaur -S pokete-git
```

Or you can just run the AppImage from the release page.

NOTE: In that case you first have to create the `~/.cache/pokete/` folder.

For Windows:

Some windows antivirus may flag the `libplaysound.dll` as malicious. If pokete crashes, please make sure that the .dll
exists and is **not** in quarantine!

If you have problems with your ARCH you maybe need to rebuild the audio module, see [here](playsound/README.md).

## Running locally

```shell
pip install scrap_engine
git clone https://github.com/lxgr-linux/pokete.git
cd pokete/src
python -m pokete
```

## Usage

The game can be run normally without supplying any options.
For non gameplay related usage, use `--help`.
Try it out [online](https://replit.com/@lxgr-linux/pokete).

## How to play

Imagine that you're a Pokete Trainer and you travel around the world to catch/train as many Poketes as possible with the
ultimate goal of becoming the best trainer.

First of all you get a starter Pokete (Steini), that you can use to fight battles with other Poketes.
Use W, A, S and D to move around.

When entering the high grass (;), you may be attacked by a wild Pokete. By pressing `1` you can choose between the
attacks your Pokete has (as long their AP is over 0). By pressing the according number, or navigating with the `*`
cursor to the attack and pressing `Enter` you can use the attack selected. The wild Pokete will fight back, but you can
kill it and gain XP to level up your Pokete. If you would like to catch a wild Pokete, you must first weaken it and then
throw a Poketeball. With a bit of luck, you can catch it and have it fight for you.

By pressing the `1` key, you can take a look at your current deck. You can see detailed information of your Pokete and
your attacks, or rearrange them.
Changes will only be saved by quitting the game using the exit function.

Since you're a Pokete Trainer, you can also fight against other trainers (they appear as an 'a'). He will start a fight
with you when you get close enough to him. You can not run from a trainer fight; you either have to win, or lose. These
trainer fights give double the XP.

When one of your Poketes is too weak or dies, you can heal it by going into the Pokete Center (the house), talk the the
person there and choose the healing option.
Here you can also take a look at all of your Poketes, and not just the six in your team. The ones marked with an `o` are
the ones in your deck.

By pressing `e`, a menu will appear where player name, and later other settings, can be changed.

The red balls all over the map are Poketeballs. You'll need these to catch Poketes. Stepping on such a ball will add it
to your inventory.

See [How to play](docs/HowToPlay.md).

## Game depth

Not only are there Poketes that are stronger than others, but also Poketes with different types, which are effective
against some types and ineffective against others.

| Type    | Effective against            | Ineffective against |
|---------|------------------------------|---------------------|
| Normal  |                              |                     |
| Stone   | Flying, Fire                 | Plant               |
| Plant   | Stone, Ground, Water         | Fire, Ice           |
| Water   | Stone, Flying, Fire          | Plant, Ice          |
| Fire    | Flying, Plant, Undead, Ice   | Stone, Water        |
| Ground  | Normal                       | Flying              |
| Electro | Stone, Flying                | Ground              |
| Flying  | Plant                        | Stone               |
| Undead  | Normal, Ground, Plant, Water | Fire                |
| Ice     | Water, Plant                 | Fire                |

For additional information you can see [wiki](docs/wiki.md) or
[the multi-page wiki](https://lxgr-linux.github.io/pokete/wiki-multi).

## Mods

Mods can be written to extend Pokete. To load a mod, the mod has to be placed in `mods` and mods have to be enabled in
the menu.
For an example mod see [example.py](mods/example.py).

## Tips

- When you want to see the next part of a conversation, press any key
- Don't play on full-screen; the game will not run properly
- Don't be offended by the other trainers; they may swear at you

## TODO

- [x] A wizard at the start to set name and starter Pokete
- [ ] More maps
- [x] Types for attacks and Poketes
- [x] Evolving
- [x] More than one Pokete for trainers
- [x] Coloured Poketes
- [x] A store to buy Poketeballs
- [x] Potions
- [x] Intro
- [x] Trading
- [x] Poketedex
- [x] Effects
- [x] Colour codes for types

## Dependencies

Pokete depends on python3 and the `scrap_engine` module.
On Windows `pynput` has to be installed too.

## Documentation

- [Documentation for pokete_classes](https://lxgr-linux.github.io/pokete/doc/pokete_classes/index.html)
- [Documentation for pokete_data](https://lxgr-linux.github.io/pokete/doc/pokete_data/index.html)
- [Documentation for the util file](https://lxgr-linux.github.io/pokete/doc/util.html)
- [Documentation for the pokete_general_use_fns](https://lxgr-linux.github.io/pokete/doc/pokete_general_use_fns.html "pokete_general_use_fns.py")
- [Documentation for the main file "pokete.py"](https://lxgr-linux.github.io/pokete/doc/pokete.html "pokete.py")

## Releases

For release information see [Changelog](Changelog.md).

## Contributing

Feel free to contribute whatever you want to this game.
New Pokete contributions are especially welcome, those are located in /pokete_data/poketes.py

To learn how to add more poketes/types/attacks to the game, see [the development guide](docs/DevGuide.md)

After adding new Poketes and/or attacks you may want to run

```shell
$ ./util.py wiki
```

to regenerate the wiki and adding them to it.

## Migrating to flatpak

If you're migrating to the flatpak release, move your `~/.local/share/pokete/pokete.json`
to `~/.var/app/com.github.lxgr_linux.pokete/data/pokete/pokete.json`.

## Credits

Music:

- Eric Skiff - Resistor Anthems - Available at [http://EricSkiff.com/music](http://EricSkiff.com/music)
- Marllon Silva (xDeviruchi) - 8-bit-fantasy-adventure-music-pack - Available
  at [itch.io](https://xdeviruchi.itch.io/8-bit-fantasy-adventure-music-pack)
- SketchyLogic - Map - Available
  at [opengameart.org](https://opengameart.org/content/nes-shooter-music-5-tracks-3-jingles)

## Troubleshooting

If you're experiencing problems on Japanese systems take a look
at [this](https://gist.github.com/z80oolong/c7523367b798bdda094f859342f4c8be).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pokete",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "game, Ascii",
    "author": null,
    "author_email": "lxgr <lxgr@protonmail.com>",
    "download_url": null,
    "platform": null,
    "description": "[![Wiki](https://github.com/lxgr-linux/pokete/actions/workflows/main.yml/badge.svg)](https://github.com/lxgr-linux/pokete/actions/workflows/main.yml)\n[![Code-Validation](https://github.com/lxgr-linux/pokete/actions/workflows/main_validate.yml/badge.svg)](https://github.com/lxgr-linux/pokete/actions/workflows/main_validate.yml)\n![License](https://img.shields.io/github/license/lxgr-linux/pokete)\n![AUR version](https://img.shields.io/aur/version/pokete-git)\n<br>\n![Open Issues](https://img.shields.io/github/issues/lxgr-linux/pokete)\n![Open pull requests](https://img.shields.io/github/issues-pr/lxgr-linux/pokete)\n![commit activity](https://img.shields.io/github/commit-activity/m/lxgr-linux/pokete)\n![commits since last release](https://img.shields.io/github/commits-since/lxgr-linux/pokete/latest/master?include_prereleases)\n![GitHub contributors](https://img.shields.io/github/contributors/lxgr-linux/pokete)\n\n# Pokete -- Grey Edition\n\n![Example](assets/ss/ss01.png)\n\n[See more example pics](assets/pics.md)\n\n## What is it?\n\nPokete is a small terminal based game in the style of a very popular and old game by Gamefreak.\n\n## Installation\n\n```shell\npip install pokete\n```\n\nYou can also install it from the AUR:\n\n```shell\n$ buildaur -S pokete-git\n```\n\nOr you can just run the AppImage from the release page.\n\nNOTE: In that case you first have to create the `~/.cache/pokete/` folder.\n\nFor Windows:\n\nSome windows antivirus may flag the `libplaysound.dll` as malicious. If pokete crashes, please make sure that the .dll\nexists and is **not** in quarantine!\n\nIf you have problems with your ARCH you maybe need to rebuild the audio module, see [here](playsound/README.md).\n\n## Running locally\n\n```shell\npip install scrap_engine\ngit clone https://github.com/lxgr-linux/pokete.git\ncd pokete/src\npython -m pokete\n```\n\n## Usage\n\nThe game can be run normally without supplying any options.\nFor non gameplay related usage, use `--help`.\nTry it out [online](https://replit.com/@lxgr-linux/pokete).\n\n## How to play\n\nImagine that you're a Pokete Trainer and you travel around the world to catch/train as many Poketes as possible with the\nultimate goal of becoming the best trainer.\n\nFirst of all you get a starter Pokete (Steini), that you can use to fight battles with other Poketes.\nUse W, A, S and D to move around.\n\nWhen entering the high grass (;), you may be attacked by a wild Pokete. By pressing `1` you can choose between the\nattacks your Pokete has (as long their AP is over 0). By pressing the according number, or navigating with the `*`\ncursor to the attack and pressing `Enter` you can use the attack selected. The wild Pokete will fight back, but you can\nkill it and gain XP to level up your Pokete. If you would like to catch a wild Pokete, you must first weaken it and then\nthrow a Poketeball. With a bit of luck, you can catch it and have it fight for you.\n\nBy pressing the `1` key, you can take a look at your current deck. You can see detailed information of your Pokete and\nyour attacks, or rearrange them.\nChanges will only be saved by quitting the game using the exit function.\n\nSince you're a Pokete Trainer, you can also fight against other trainers (they appear as an 'a'). He will start a fight\nwith you when you get close enough to him. You can not run from a trainer fight; you either have to win, or lose. These\ntrainer fights give double the XP.\n\nWhen one of your Poketes is too weak or dies, you can heal it by going into the Pokete Center (the house), talk the the\nperson there and choose the healing option.\nHere you can also take a look at all of your Poketes, and not just the six in your team. The ones marked with an `o` are\nthe ones in your deck.\n\nBy pressing `e`, a menu will appear where player name, and later other settings, can be changed.\n\nThe red balls all over the map are Poketeballs. You'll need these to catch Poketes. Stepping on such a ball will add it\nto your inventory.\n\nSee [How to play](docs/HowToPlay.md).\n\n## Game depth\n\nNot only are there Poketes that are stronger than others, but also Poketes with different types, which are effective\nagainst some types and ineffective against others.\n\n| Type    | Effective against            | Ineffective against |\n|---------|------------------------------|---------------------|\n| Normal  |                              |                     |\n| Stone   | Flying, Fire                 | Plant               |\n| Plant   | Stone, Ground, Water         | Fire, Ice           |\n| Water   | Stone, Flying, Fire          | Plant, Ice          |\n| Fire    | Flying, Plant, Undead, Ice   | Stone, Water        |\n| Ground  | Normal                       | Flying              |\n| Electro | Stone, Flying                | Ground              |\n| Flying  | Plant                        | Stone               |\n| Undead  | Normal, Ground, Plant, Water | Fire                |\n| Ice     | Water, Plant                 | Fire                |\n\nFor additional information you can see [wiki](docs/wiki.md) or\n[the multi-page wiki](https://lxgr-linux.github.io/pokete/wiki-multi).\n\n## Mods\n\nMods can be written to extend Pokete. To load a mod, the mod has to be placed in `mods` and mods have to be enabled in\nthe menu.\nFor an example mod see [example.py](mods/example.py).\n\n## Tips\n\n- When you want to see the next part of a conversation, press any key\n- Don't play on full-screen; the game will not run properly\n- Don't be offended by the other trainers; they may swear at you\n\n## TODO\n\n- [x] A wizard at the start to set name and starter Pokete\n- [ ] More maps\n- [x] Types for attacks and Poketes\n- [x] Evolving\n- [x] More than one Pokete for trainers\n- [x] Coloured Poketes\n- [x] A store to buy Poketeballs\n- [x] Potions\n- [x] Intro\n- [x] Trading\n- [x] Poketedex\n- [x] Effects\n- [x] Colour codes for types\n\n## Dependencies\n\nPokete depends on python3 and the `scrap_engine` module.\nOn Windows `pynput` has to be installed too.\n\n## Documentation\n\n- [Documentation for pokete_classes](https://lxgr-linux.github.io/pokete/doc/pokete_classes/index.html)\n- [Documentation for pokete_data](https://lxgr-linux.github.io/pokete/doc/pokete_data/index.html)\n- [Documentation for the util file](https://lxgr-linux.github.io/pokete/doc/util.html)\n- [Documentation for the pokete_general_use_fns](https://lxgr-linux.github.io/pokete/doc/pokete_general_use_fns.html \"pokete_general_use_fns.py\")\n- [Documentation for the main file \"pokete.py\"](https://lxgr-linux.github.io/pokete/doc/pokete.html \"pokete.py\")\n\n## Releases\n\nFor release information see [Changelog](Changelog.md).\n\n## Contributing\n\nFeel free to contribute whatever you want to this game.\nNew Pokete contributions are especially welcome, those are located in /pokete_data/poketes.py\n\nTo learn how to add more poketes/types/attacks to the game, see [the development guide](docs/DevGuide.md)\n\nAfter adding new Poketes and/or attacks you may want to run\n\n```shell\n$ ./util.py wiki\n```\n\nto regenerate the wiki and adding them to it.\n\n## Migrating to flatpak\n\nIf you're migrating to the flatpak release, move your `~/.local/share/pokete/pokete.json`\nto `~/.var/app/com.github.lxgr_linux.pokete/data/pokete/pokete.json`.\n\n## Credits\n\nMusic:\n\n- Eric Skiff - Resistor Anthems - Available at [http://EricSkiff.com/music](http://EricSkiff.com/music)\n- Marllon Silva (xDeviruchi) - 8-bit-fantasy-adventure-music-pack - Available\n  at [itch.io](https://xdeviruchi.itch.io/8-bit-fantasy-adventure-music-pack)\n- SketchyLogic - Map - Available\n  at [opengameart.org](https://opengameart.org/content/nes-shooter-music-5-tracks-3-jingles)\n\n## Troubleshooting\n\nIf you're experiencing problems on Japanese systems take a look\nat [this](https://gist.github.com/z80oolong/c7523367b798bdda094f859342f4c8be).\n",
    "bugtrack_url": null,
    "license": "GPL-3.0-only",
    "summary": "A terminal based Pokemon like game",
    "version": "0.10.0rc4",
    "project_urls": {
        "Homepage": "https://github.com/lxgr-linux/pokete",
        "Issues": "https://github.com/lxgr-linux/pokete/issue",
        "Repository": "https://github.com/lxgr-linux/pokete.git"
    },
    "split_keywords": [
        "game",
        " ascii"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "af9b53bfe770898bd696acb11a68741ac6d93a2b413dc07e320f50022bffef89",
                "md5": "f19f56ca77a518cbd2c3252287839fdc",
                "sha256": "edb3908143706c3d3ecc46977bea3d426e6953b80999db1de6a0495451f2855b"
            },
            "downloads": -1,
            "filename": "pokete-0.10.0rc4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f19f56ca77a518cbd2c3252287839fdc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 85179808,
            "upload_time": "2025-07-26T22:40:41",
            "upload_time_iso_8601": "2025-07-26T22:40:41.682409Z",
            "url": "https://files.pythonhosted.org/packages/af/9b/53bfe770898bd696acb11a68741ac6d93a2b413dc07e320f50022bffef89/pokete-0.10.0rc4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-26 22:40:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "lxgr-linux",
    "github_project": "pokete",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pokete"
}
        
Elapsed time: 1.46317s