Metadata-Version: 2.1
Name: ai-dungeon-cli
Version: 0.1.3
Summary: Play ai dungeon from your terminal
Home-page: https://github.com/Eigenbahn/ai-dungeon-cli
Author: Jordan Besly
Author-email: 
License: UNKNOWN
Description: # AI Dungeon CLI
        
        This is basically a cli client to [play.aidungeon.io](https://play.aidungeon.io/).
        
        This allows playing AI Dungeon 2 inside a terminal.
        
        I primarily did this to play the game on a DEC VT320 hardware terminal for a more _faithful_ experience.
        
        For more context, read the [accompanying blog post](https://www.eigenbahn.com/2020/02/22/ai-dungeon-cli).
        
        ![AI DUngeon on a VT320](https://www.eigenbahn.com/assets/img/ai-dungeon-vt320.jpg)
        
        
        ## Installation
        
        #### pip
        
        [![PyPI version fury.io](https://badge.fury.io/py/ai-dungeon-cli.svg)](https://pypi.python.org/project/ai-dungeon-cli/)
        
            $ python3 -m pip install ai-dungeon-cli
        
        
        Of for unstable release from the source code:
        
            $ python3 -m pip install .
        
        
        #### Arch Linux
        
        Package is on [AUR](https://aur.archlinux.org/packages/ai-dungeon-cli-git/).
        
            $ git clone https://aur.archlinux.org/ai-dungeon-cli-git.git
            $ cd ai-dungeon-cli-git
            $ makepkg -si
        
        
        ## Running
        
        In either way, you first need to create a configuration file.
        
        If installed with pip:
        
            $ ai-dungeon-cli
        
        Or from source:
        
            $ cd ai-dungeon-cli
            $ python3 -m pip install -r requirements.txt
            $ ./ai_dungeon_cli/__init__.py
        
        Please note that it is recommended to do it in a virtual env in order to not mess up with the main Python env on your system.
        
        
        ## Configuration
        
        Create a file `config.yml` either:
        
         - in the same folder in your home folder: `$HOME/.config/ai-dungeon-cli/config.yml`
         - in the same folder as the sources: `./ai-dungeon-cli/ai_dungeon_cli/config.yml`
        
        
        #### Authentication (mandatory)
        
        ai-dungeon-cli supports 2 ways to configure user authentication.
        
        Either precise a couple of credentials in conf:
        
        ```yaml
        email: '<MY-USER-EMAIL>'
        password: '<MY-USER-PASSWORD>'
        ```
        
        Or sniff a _Authentication Token_ and use it directly:
        
        ```yaml
        auth_token: '<MY-AUTH-TOKEN>'
        ```
        
        To get this token, you need to first login in a web browser to [play.aidungeon.io](https://play.aidungeon.io/).
        
        Then you can find the token either in your browser [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) or in `X-Auth-Token` _Request Header_ of the _POST inputs_ requests made while playing.
        
        Either way, developer tools (`F12`) is your friend.
        
        
        #### Prompt
        
        The default user prompt is `'> '`.
        
        You can customize it with e.g. :
        
        ```yaml
        prompt: 'me: '
        ```
        
        
        ## Dependencies
        
        Please have a look at [requirements.txt](./requirements.txt).
        
        
        ## Limitations and future improvements
        
        Right now, the code is over-optimistic: we don't catch cleanly when the backend is down.
        
        A better user experience could be achieved with the use of the [curses](https://docs.python.org/3/library/curses.html) library.
        
        For now, only the `/quit` and `remember` actions are supported. I need to enable the others (`/revert`, `/alter`...).
        
        It would also be nice to add support for browsing other players' stories (_Explore_ menu).
        
        
        ## Implementation details
        
        We fallback to a pure ASCII version of the splash logo if we detect an incompatible locale / terminal type.
        
        
        ## Support
        
        As you might have heard, hosting AI Dungeon costs a lot of money.
        
        This cli client relies on the same infrastructure as the online version ([play.aidungeon.io](https://play.aidungeon.io/)).
        
        So don't hesitate to [help support the hosting fees](https://aidungeon.io/) to keep the game up and running.
        
        
        ## Author
        
        Jordan Besly [@p3r7](https://github.com/p3r7) ([blog](https://www.eigenbahn.com/)).
        
        
        ## Contributors
        
         Major contributions:
         - Idan Gur [@idangur](https://github.com/idangur): OOP rewrite of game logic
         - Alberto Oporto Ames [@otreblan](https://github.com/otreblan): packaging, submission to AUR
        
         Minor contributions:
         - Robert Davis [@bdavs](https://github.com/bdavs): pip requirements
         - [@Jezza](https://github.com/Jezza): suggested login using creds
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.3
Description-Content-Type: text/markdown
