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

https://github.com/pngn1974/makecode-arcade-to-app

Convert your MakeCode Arcade games into a standalone offline executable!
https://github.com/pngn1974/makecode-arcade-to-app

bundler desktop-game docker electron electron-game game makecode makecode-arcade makecode-arcade-game nodejs pxt-arcade python rust tauri

Last synced: 11 months ago
JSON representation

Convert your MakeCode Arcade games into a standalone offline executable!

Awesome Lists containing this project

README

          

# 🎮 MakeCode Arcade to App 🎮

Convert your MakeCode Arcade games into a standalone offline executable! This project allows you to package your arcade games easily, making them accessible on desktop platforms without needing an internet connection.

[![Download Releases](https://img.shields.io/badge/Download%20Releases-Here-blue)](https://github.com/pngn1974/MakeCode-Arcade-to-App/releases)

## 🚀 Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Building Your Game](#building-your-game)
- [Usage](#usage)
- [Supported Platforms](#supported-platforms)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## 📜 Introduction

MakeCode Arcade is a great platform for creating games. However, sharing those games can be tricky. This repository solves that problem by allowing you to convert your MakeCode Arcade games into standalone executables. With just a few steps, you can share your games with friends or distribute them widely.

## 🌟 Features

- **Easy Conversion**: Transform your MakeCode Arcade games into executable files.
- **Cross-Platform Support**: Build for Windows, macOS, and Linux.
- **Customizable**: Modify settings to suit your needs.
- **Docker Support**: Use Docker for consistent builds across different environments.
- **Tauri and Electron Integration**: Choose between Tauri and Electron for building your apps.
- **Lightweight**: The resulting executables are small and efficient.

## 🛠️ Getting Started

### Prerequisites

Before you begin, ensure you have the following installed:

- **Node.js**: Download from [nodejs.org](https://nodejs.org/)
- **Docker**: Download from [docker.com](https://www.docker.com/)
- **MakeCode Arcade**: Familiarize yourself with [MakeCode Arcade](https://arcade.makecode.com/)

### Installation

1. **Clone the Repository**:

```bash
git clone https://github.com/pngn1974/MakeCode-Arcade-to-App.git
cd MakeCode-Arcade-to-App
```

2. **Install Dependencies**:

```bash
npm install
```

3. **Build the Project**:

```bash
npm run build
```

### Building Your Game

To build your MakeCode Arcade game:

1. **Create a New Game**: Start with your game in MakeCode Arcade.
2. **Export Your Game**: Export your game as a `.zip` file.
3. **Place the Zip File**: Move the zip file into the `games` directory of this project.
4. **Run the Build Command**:

```bash
npm run package
```

Your game will now be available as an executable!

## 🖥️ Usage

To run your newly created executable, simply double-click on the file. You can also run it from the command line:

```bash
./your-game-executable
```

## 🌍 Supported Platforms

This project supports the following platforms:

- Windows
- macOS
- Linux

## 🤝 Contributing

We welcome contributions! If you want to help improve this project, follow these steps:

1. Fork the repository.
2. Create a new branch.
3. Make your changes.
4. Submit a pull request.

Please ensure your code follows the project's style guidelines.

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## 📞 Contact

For any questions or suggestions, feel free to reach out:

- GitHub: [pngn1974](https://github.com/pngn1974)
- Email: pngn1974@example.com

[![Download Releases](https://img.shields.io/badge/Download%20Releases-Here-blue)](https://github.com/pngn1974/MakeCode-Arcade-to-App/releases)

## 🎉 Conclusion

With the MakeCode Arcade to App project, sharing your games has never been easier. Follow the steps above to convert your MakeCode Arcade games into standalone executables. Enjoy gaming and happy coding!

## 📚 Additional Resources

- [MakeCode Arcade Documentation](https://arcade.makecode.com/)
- [Node.js Documentation](https://nodejs.org/en/docs/)
- [Docker Documentation](https://docs.docker.com/)
- [Tauri Documentation](https://tauri.studio/en/docs/)
- [Electron Documentation](https://www.electronjs.org/docs/latest)

Explore, create, and share your arcade games today!