Repo Information

We are running a lightweight Koa server written in TypeScript, with a MariaDB database leveraging MikroORM, as our ORM of choice. The client is written in ActionScript 3 and uses Adobe FlashPlayer to display its content.

This repository contains the entire modified SWF (Shockwave Flash) client files, along with the corresponding server component rebuilt from the ground up for Kixeye's 2010 Flash client, Backyard Monsters. The client is running on version 128.5690.

🚀 How to Play

We recommend to download our game launcher which can be installed from our website's download page. This will allow you to seamlessly manage what build versions of the client you play, all from one place, without worrying about manually downloading new versions. The launcher currently supports Windows (64-bit) and Linux.

🗄️ Server setup

It is possible to run the server manually or to deploy it using Docker Compose.

Repository Setup

Start by cloning the repository and switching to the develop branch:

git clone https://github.com/bym-refitted/backyard-monsters-refitted
cd backyard-monsters-refitted
git switch develop

🐳 Docker Deployment

You can deploy the server locally using Docker with our docker-compose file.

Important: Do NOT use the docker-compose.yml file as is for production. It contains hardcoded secret keys as well as weak database credentials meant for local use only.

Deployment Components

The deployment includes the following containers:

• 🎮 Game Server: Runs a web server based on a custom Docker image built from server/Dockerfile.
• 💿 MariaDB: Provides the database backend.
• 📄 phpMyAdmin: Allows you to manage and inspect the database.

Setting It Up

1. Install Docker
2. Navigate to the cloned repository in your terminal
3. Start the deployment:

docker compose up

4. Verify that services are running:
   • Game Server: Visit http://localhost:3001 to confirm the API is online.
   • phpMyAdmin: Access http://localhost:8080. Use the default credentials (username: bymr, password: bymr) or update them in docker-compose.yml.
5. Connect to the server: Use the latest release of the SWF file or compile it manually (instructions provided below).

🛠️ Manual Deployment

Follow the instructions carefully on our server setup & configuration Wiki page.

💻 Client Setup

1. Follow the instructions carefully on our client setup & configuration Wiki page.

2. To contribute you will need to copy your changes to the src directory. If you are wondering why we are using this horrible workflow please see CONTRIBUTING.md for more information. If you are able to figure out how to compile directly to swf without unlinking all assets, please let us know.

📱 Android Setup

1. To compile an APK for Android follow our Android Application Setup Wiki page.

Preservation of digital heritage

• Exemption to PCCPSACT, exemptions to the provision of the Digital Millennium Copyright Act (“DMCA”).
• EFGAMP, the European Federation of Video Game Archives, Museums and Preservation projects.
• UNESCO PERSIST Programme, helps ensure that digital information can continue to be accessed in the future.
• The Internet Archive, a digital library of Internet sites and other cultural artifacts in digital form.
• Flashpoint Archive, the webgame preservation project.
• Adobe Flash Player Archive, the Adobe Inc. archive.org Flash Player Archive.

License

Backyard Monsters preservation project.
Copyright (C) 2024 | The Backyard Monsters Refitted team
See the GNU General Public License <https://www.gnu.org/licenses/>.