An open API service indexing awesome lists of open source software.

https://github.com/nongtajkrub/sortsquad

A game that promotes correctly sorting trash in celebration of Environmental Day. Its support both desktop and web version.
https://github.com/nongtajkrub/sortsquad

collaboration game gameengine2d pygame python school-project

Last synced: 5 months ago
JSON representation

A game that promotes correctly sorting trash in celebration of Environmental Day. Its support both desktop and web version.

Awesome Lists containing this project

README

          

# 🎮 Sortsquad

![Language](https://img.shields.io/badge/language-Python-blue?logo=python)
![Language](https://img.shields.io/badge/language-TypeScript-3178C6?logo=typescript&logoColor=blue)
![Status](https://img.shields.io/badge/status-Finished-green)

> A game that promotes correctly sorting trash in celebration of Environmental Day.

A local multiplayer game that promotes correctly sorting trash in celebration of Environmental Day. The desktop version is built with Pygame, while the web version is build in TypeScript using Phaser. The game was originally developed in just 7 days—you can check out that version on the [7days branch](https://github.com/Nongtajkrub/Sortsquad/tree/7days). Initially created as a showcase for an event hosted by the Phuket Provincial Administrative Organization (องค์การบริหารส่วนจังหวัดภูเก็ต), the game has since been refined and enhanced, including a full rewrite for web support, to allow it to be presented at additional events.

![Screenshots of the game as a Gif file.](/docs/screenshots.gif)

---

## 📄 License

* We developed this project as a student of [Kajonkietsuksa School](https://kg.kajonkietsuksa.ac.th/).
* [Click here to view the license information.](https://github.com/Nongtajkrub/Sortsquad?tab=License-1-ov-file)

![Kajonkietsuksa School Logo](/docs/kajonkietsuksa.png)

---

### 👏 Contributors

> [!IMPORTANT]
> Listed in no particular order — every contribution is valued equally.

* Taj Borthwick
* Kritapas Maswongssa
* Isaac Zogg

---

## ⚙️ Setup (Python)

To run this game, make sure you have the following dependencies installed:

* `Python` 3.11 or later
* `Pygame` (Python library for game development)

### 🛠️ Install Dependencies

If you haven't installed `Python` yet, follow this guide:

https://wiki.python.org/moin/BeginnersGuide/Download

If you haven't installed `Pygame` yet, you can do so using pip:

```bash
pip install pygame
```

### ▶️ Running the Game

To start the game, run the following command from the project root directory:
```bash
python python/src/main.py
```

> [!CAUTION]
> Running the game from the project root ensures that all assets load correctly. If you see errors related to missing assets, double-check that you're in the root directory (where main `README.md` and the `docs/` folder are located).

---

## ⚙️ Setup (Web)

You can play the web version of **Sortsquad** (simplified) directly in your browser, no installation required. The game is hosted on GitHub Pages at the link below:

https://nongtajkrub.github.io/Sortsquad/

---