Metadata-Version: 2.2
Name: PhotonEngine
Version: 0.0.5.dev0
Summary: A  game engine written in Python
Home-page: https://github.com/arnavchoudhary9/photon
Author: Arnav Choudhary
Author-email: arnavhoudhary.6969@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: build>=1.2.2.post1
Requires-Dist: Cython==0.29.28
Requires-Dist: debugpy>=1.6.6
Requires-Dist: esper==2.5
Requires-Dist: glfw>=2.1.0
Requires-Dist: numpy>=1.21.0
Requires-Dist: Pillow>=8.1.0
Requires-Dist: PyOpenGL>=3.1.5
Requires-Dist: PyWavefront>=1.3.3
Requires-Dist: pyrr>=0.10.3
Requires-Dist: pytest>=8.2.1
Requires-Dist: PyYAML>=6.0
Requires-Dist: spdlog>=2.0.4
Requires-Dist: twine>=6.1.0
Requires-Dist: watchdog>=3.0.0
Requires-Dist: wheel>=0.45.1
Requires-Dist: pyinstaller>=4.7
Requires-Dist: snakeviz
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-dist
Dynamic: summary

# Photon

Photon is a game engine written in Python just for fun.

## Installation

### Requirements

1. **Python >=3.10**  
   The engine is based on [Python 3.10](https://www.python.org/downloads/release/python-31012), so it is preferred that you use Python 3.10 or upgrade to a version supported by [PyImGUI](https://github.com/pyimgui/pyimgui).

2. **Virtual Environment (venv)**  
   Install using:

   ```sh
   pip install venv
   ```

There are two ways to run the editor. If you just want to use the engine to make games or test its performance, you can download the [precompiled binaries](https://github.com/ArnavChoudhary9/Photon/releases). If you want to develop the engine and see how it works, you can download the [source code from GitHub](https://github.com/ArnavChoudhary9/Photon/).

### 1. Precompiled Binaries

1. Download the [precompiled binaries](https://github.com/ArnavChoudhary9/Photon/releases) from [GitHub](https://github.com/ArnavChoudhary9/Photon).
2. Extract the files and run `Forge.exe`.

> Congratulations! You have successfully installed Photon and Forge Editor.

### 2. Compile from Source

1. Clone the repository:

   ```sh
   git clone --recursive https://github.com/ArnavChoudhary9/Photon
    ```

2. Navigate to the project directory:

   ```sh
   cd Photon
   ```

3. Initialize the repository:

   ```sh
   setup.bat
   ```

4. Activate the virtual environment:

   ```sh
   venv\Scripts\activate
   ```

5. Run Forge Editor:

   ```sh
   cd Forge
   python Forge.py
   ```

> Congratulations! You have successfully run Forge Editor.

Photon draws a lot of inspiration from [Hazel](https://github.com/TheCherno/Hazel) and takes a lot of learning from [The Cherno](https://youtube.com/playlist?list=PLlrATfBNZ98dC-V-N3m0Go4deliWHPFwT&si=joZeeB9E0mV37S28).

- Find [Documentation here](https://arnavchoudhary9.github.io/Photon/docs/book)
- Visit the [DevLog site here](https://arnavchoudhary9.github.io/Photon/devlogs/book)
