README.md

![Pokémon](Pictures/logo.png "Pokémon")
<h1 align="center">:atom: PythonRed Version :electron:</h1>

<p align="center">
	<a href="https://GitHub.com/TurnipGuy30/Pokemon-PythonRed"><img src="https://gpvc.arturio.dev/Pokemon-PythonRed"></a> <!--Views-->
	<a href="https://GitHub.com/TurnipGuy30/Pokemon-PythonRed/graphs/commit-activity"><img src="https://img.shields.io/badge/maintained%3F-yes-green.svg"></a> <!--Maintained?-->
	<a href="https://GitHub.com/TurnipGuy30"><img src="https://img.shields.io/badge/maintainer-TurnipGuy30-blue"></a> <!--Maintainer-->
	<a href="https://www.python.org/"><img src="https://img.shields.io/badge/made%20with-Python-1f425f.svg"></a> <!--Made with Python-->
	<a href="https://www.microsoft.com/en-au/software-download/windows10"><img src="https://img.shields.io/badge/platform-Windows%2010-yellow"></a> <!--Platform-->
	<a href="https://GitHub.com/TurnipGuy30/Pokemon-PythonRed/releases/latest"><img src="https://img.shields.io/badge/latest%20version-v0.0.5-cyan"></a> <!--Latest version-->
	<a href="https://GitHub.com/TurnipGuy30/Pokemon-PythonRed/releases"><img src="https://img.shields.io/badge/stable%3F-yes-brightgreen"></a> <!--Stable?-->
	<a href="https://GitHub.com/TurnipGuy30/Pokemon-PythonRed/issues"><img src="https://img.shields.io/github/issues/TurnipGuy30/Pokemon-PythonRed.svg"></a> <!--Issues-->
	<a href="https://github.com/TurnipGuy30/Pokemon-PythonRed/stargazers"><img src="https://img.shields.io/github/stars/TurnipGuy30/Pokemon-PythonRed"/></a> <!--Stars-->
</p>

---
<h6 align="center">A fan-made, text-adventure Pokémon game in Python!</h6>

---

<br>

<a href="https://github.com/TurnipGuy30/Pokemon-PythonRed/discussions">Discussions</a> is a great place to ask questions or give quick feedback!

<details><summary>Important Notes</summary>

---
* This is not a perfect recreation of _Pokémon Red_; it's a fan-made game that, like _Pokémon Red_, takes place in the _Kanto_ region.
* Prior in-depth knowledge of the _Pokémon_ franchise, especially the video game series, is recommended and may be required to fully enjoy this game.
* _Windows_ OS only!! This game makes use of _Python_'s `winsound` module, which is exclusive to _Windows_.
* This project (this GitHub Repository and anything found within) is not endorsed by _Nintendo_, _GAME FREAK_, or _The Pokémon Company_. This is an independent, fan-made game.
* This game's plot is a work of fiction!
---
</details>

### Credits:
#### Owners:

* @[TurnipGuy30](https://github.com/TurnipGuy30 "TurnipGuy30's Profile") - Performs Commits (updates the game, makes README changes)
* @[Isabel-Lifu-211207-XPrado](https://github.com/Isabel-Lifu-211207-XPrado "Isabel-Lifu-211207-XPrado's Profile") - Manages Bug Reports
* @[hacking-mudkip](https://github.com/hacking-mudkip "hacking-mudkip's Profile") - Just really cool (best GitHub username!)

<details><summary>All Contributions:</summary>

---
* @[hacking-mudkip](https://github.com/hacking-mudkip "hacking-mudkip's Profile") - Concept ideas, porting elements
* @[Isabel-Lifu-211207-XPrado](https://github.com/Isabel-Lifu-211207-XPrado "Isabel-Lifu-211207-XPrado's Profile") - Code cleaning, general troubleshooting
* @[JeremyLARDENOIS](https://github.com/JeremyLARDENOIS "JeremyLARDENOIS's Profile") - Testing and feedback
* Looking for others!
---
</details>

### To Install:

#### Summary

Following this list is perfectly fine:

1. Install [Python IDLE](https://www.python.org/downloads/ "Python Latest")
2. Run [Dependency Commands](https://github.com/TurnipGuy30/Pokemon-PythonRed#2-installing-dependencies "On this page: Installing Dependencies")
3. Install [7-zip](https://7-zip.org "7-zip Latest")
4. Download [the latest Release](https://github.com/TurnipGuy30/Pokemon-PythonRed/releases/latest "Pokémon PythonRed Releases")

If you encounter any problems throughout the installation process, see `Step-by-Step Installation` below. If problems persist, please create an [Issue](https://github.com/TurnipGuy30/Pokemon-PythonRed/issues "Pokémon PythonRed Issues").

#### Step-by-Step Installation
<details><summary>1. Installing <code>Python IDLE</code></summary>

---
First, ensure you have _Python_ installed. If not, you can find the latest installer [here](https://www.python.org/downloads/ "Python Latest"). Tick the box that says `Add Python to PATH` during installation.

However, if you are using a work/school computer and are not an Admin, you don't need to tick `py launcher`, which requires Administrative privileges to install. All `py launcher` does is let you use `Python IDLE` from the Command Line, which is not required for this game.

This also installs `pip`, _Python_'s package installer, which is required in the next step.

---
</details>

<details><summary>2. Installing Dependencies</summary>

---
Open your favourite Shell Terminal and _individually_ run any below commands:

```
pip install playsound
```

###### (More commands will be added above as they are needed)
###### Common Shell Terminals include `Command Prompt`, `Windows PowerShell`, `Git CMD`, etc.

If it all runs smoothly with no errors, continue to the next step.

---
</details>

<details><summary>3. Installing 7-zip</summary>

---
`Pokémon PythonRed` is released as an SFX '.exe' file, which requires _7-zip_ to open. Work/school computers might already have _7-zip_ installed, but if not, the latest version can be found [here](https://7-zip.org "7-zip Latest").

---
</details>

<details><summary>4. Downloading <code>Pokémon PythonRed</code></summary><br>

---
To download the game, please download the [latest Release](https://github.com/TurnipGuy30/Pokemon-PythonRed/releases/latest "Pokémon PythonRed Latest"), and click the download link! These links redirect to OneDrive, as they are too large to be hosted on GitHub.

Once the file has finished downloading (sorry if it takes a while!), run the '.exe' file. _7-zip_ should automatically extract the game files.

To run the game, open `Pokémon PythonRed.py`!

---
</details>

<br>

### Bugs / Feature Request
For bugs, contributions or feature requests, please create an [Issue](https://github.com/TurnipGuy30/Pokemon-PythonRed/issues "Pokémon PythonRed Issues")!

<br>

<details><summary>Resources & Additional Info (Mild Spoilers)</summary>

---
### Resources Used:
* [Kanto Region Map](https://images-wixmp-ed30a86b8c4ca887773594c2.wixmp.com/f/3bddf750-53a0-4a9f-872f-8d13685a758f/d3c4hsg-5acbd78f-c4cb-4f40-a87a-05700ac859a4.png/v1/fill/w_900,h_882,q_75,strp/labeled_map_of_kanto_by_rythos-d3c4hsg.png?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ1cm46YXBwOjdlMGQxODg5ODIyNjQzNzNhNWYwZDQxNWVhMGQyNmUwIiwic3ViIjoidXJuOmFwcDo3ZTBkMTg4OTgyMjY0MzczYTVmMGQ0MTVlYTBkMjZlMCIsImF1ZCI6WyJ1cm46c2VydmljZTppbWFnZS5vcGVyYXRpb25zIl0sIm9iaiI6W1t7InBhdGgiOiIvZi8zYmRkZjc1MC01M2EwLTRhOWYtODcyZi04ZDEzNjg1YTc1OGYvZDNjNGhzZy01YWNiZDc4Zi1jNGNiLTRmNDAtYTg3YS0wNTcwMGFjODU5YTQucG5nIiwid2lkdGgiOiI8PTkwMCIsImhlaWdodCI6Ijw9ODgyIn1dXX0.Ycjt66m7t9k-8tio4Tsc0YTsP_nu7Lz2cGBm4CdZWN8 "Kanto Region Map")
* [HP Formula](Pictures/hp.webp "HP Formula")
* [Stat Formula](Pictures/stat.png "Stat Formula")
* [_Pokémon Red_ Game Script](http://www.gamefaqs.com/features/recognition/56771.html)

### Current Priorities:
* Wild Pokémon encounters
 * Pokémon locations
 * Battle mechanics
* Saving progress

Catch Rate will be based on the `Total Stats` stat, as the Generation 1&2 Catch Rate formula is too complex, and it gets worse from then on.

For simplicity, Pokémon will only have one type each, and one attack each (a _`type`_-type attack).

###### You, dear reader, are privileged. You get to hear about Mystery Gifts! If you've played a Pokémon game before, you might know what Mystery Gifts are, and yes, they are a planned feature. Because they aren't yet implemented, you must keep your Mystery Gift Passwords safe for now. You can find Passwords around this GitHub page, and maybe other places. Entering these Passwords at a specific place in the game will grant you a special feature. But I repeat, YOU CANNOT USE THEM YET! You must wait until Fuchsia City is complete. Just you wait, I have big plans for this game!

---
</details>

#### _That's all, watch this space, and thanks!_

![](Pictures/pokeball.png)