Metadata-Version: 2.1
Name: PyTextGame
Version: 1.0
Summary: A package for building text based games.
Author-email: Himank Deka <neil.himank3@gmail.com>
Project-URL: Homepage, https://github.com/dev-hd11/pytextgame
Project-URL: Bug Tracker, https://github.com/dev-hd11/pytextgame/issues
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: keyboard

![Logo](pytextgame-high-resolution-logo-white.png)
<hr>

![PyPI - Downloads](https://img.shields.io/pypi/dm/PyTextGame)
![GitHub License](https://img.shields.io/github/license/dev-hd11/pytextgame)
![PyPI - Version](https://img.shields.io/pypi/v/PyTextGame)
![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/PyPi/PyTextGame)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/PyTextGame)
![PyPI - Wheel](https://img.shields.io/pypi/wheel/PyTextGame)


**Ultra python game development library! <br>Game development made easier than ever!**

**Announcement: Now PyTextGame is also available on SourceForge. Please visit [the official page in SourceForge](https://pytextgame.sourceforge.io).**

## 📃Table of content
1.[Introduction](#introduction)<br>
2.[Features](#features)<br>
3.[Installation](#installation)<br>
4.[Contributing](#contributing)<br>
5.[Security Policy](#security-policy)<br>
6.[Release Notes](#release-notes)<br>
- [Version 0.1 Beta](#-version-01-beta)
7. [Notices](#notices)

## 👋🏼Introduction
**PyTextGame** is a python library which can be used to develop text based games. It contains several features for making text-based game development faster.
<br><br>
©️ 2023, Himank Deka [All source code and resources]
<br> All rights reserved.

## 🪶Features
- Game development made easy
- Gaming Components
- Multi genre
- Efficient
- For both personal and commercial use
- Reducing development time
- Lifetime support
- Light on RAM & Storage
- One stop solution for game devs!

## 📩Installation
### Dependecies
- Keyboard

### Downloading
1. Create a new Python virtual environment :
```bash
python -m venv myenv
```

2. Acitivate the virtual environment :
```bash
myenv/Scripst/activate.bat
```

3. Install PyTextGame in the venv :
```bash
pip install pytextgame
```

## 🤝Contributing
See [CONTRIBUTING](./CONTRIBUTING.md).

## 🔐 Security Policy :
See [SECURITY](./SECURITY.md)

## 🗒️Release Notes

### 👩🏼‍💻 Version: 0.1 Beta:
Fixing the welcome box bug. Now you can directly pass the `show_welcome_box` argument as 
```python
False
``` 
NEW FEATURES: New `Charecter` attributes in `pytextgame.actors.charecters` and `pytextgame.actors.items` package for different items such as `Armour`, `Weapon`.
Please explore the code to learn more.

## Version: 1.0.0 :
This is the current stable version of Pytextgame. It contains features that you will require to build your game functionalities. Currently we have kept a few main features.<br>
We will keep updating the project introducing more and more features. Currently the main genre targeted by this project is RPG games. We will expand to more genres in the future.<br>
We are going to release a documentation on the package, so stay tuned!

## 🔔Notices

> [!WARNING]
> This package has been tested on Python 3.11 & 3.12.<br>

>[!NOTE]
> Live on PyPi currently.<br>
> Documentation coming soon!<br>
