Suimon: A Location-Based Collectible TCG on Sui

Metadata

• Project name: Suimon
• Date: 2024
• Participants: Sparsh, Mo, Gopi, Lucas, Lukas
• Description: Suimon is a location-based collectible trading card game (TCG) built on the Sui blockchain, where users can explore their surroundings to discover and collect unique creatures called Suimon. Created as the TUM Blockchain Club hackathon project @ Sui x BSA Hackathon V2.

Table of Contents

• Introduction
• Problem Statement
• Our Solution
• Key Features
• Technical Details
• Project Structure
• Installation
• Contributing
• License
• Contact
• Acknowledgments

Introduction

Suimon is a location-based collectible TCG that allows users to explore their surroundings and collect unique creatures called Suimon. Suimon are NFTs with different rarities and types, and users can battle each other for other Suimon using a random weighted chance of victory based on Suimon power, type advantage, and Sui's random function.

Problem Statement

Traditional TCGs are limited by their physical nature, and digital TCGs often lack the excitement of exploration and discovery. Suimon solves this problem by leveraging the Sui blockchain and location-based technology to create a unique and immersive gaming experience.

Our Solution

Suimon combines the best of both worlds by bringing the excitement of exploration and discovery to the digital realm. Our solution uses the Sui blockchain to create a secure, transparent, and decentralized gaming experience.

Key Features

• Location-based gameplay: Explore your surroundings to discover and collect unique creatures called Suimon
• Suimon NFTs: Each Suimon is a distinct NFT with different rarities and types, such as Fire, Grass, Water, and Earth
• Battles: Battle other players for Suimon using a random weighted chance of victory based on Suimon power, type advantage, and Sui's random function
• Marketplace: Trade Suimon NFTs with other players on the Suimon marketplace or on existing local marketplaces implemented using Sui Kiosk
• Security: ZK login frontend ensures user security, and Sui's built-in security features help stop frontrunners and protect user data

Technical Details

• Programming languages: Dart, Move
• Frameworks: Flutter, Sui
• Platforms: Android, iOS, Web
• Blockchain: Sui blockchain
• NFTs: Suimon NFTs are stored on the Sui blockchain
• Random number generation: Sui's random function is used to determine the outcome of battles and other random events

Project Structure

The project is organized into the following directories:

• app: Contains the Flutter application code.
• contracts: Holds the Move smart contracts for the Sui blockchain.
• tests: Includes tests for the application and smart contracts.

Installation

1. Clone the repository using git clone.
2. Navigate to the project directory using cd.
3. Run flutter pub get to install dependencies.
4. Run flutter run to launch the application.

Contributing

Contributions are welcome! To contribute, follow these steps:

1. Fork the repository using git fork.
2. Create a new branch using git branch.
3. Make changes and commit them using git commit.
4. Push changes to your fork using git push.
5. Open a pull request to merge changes into the main repository.

License

The project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or feedback, please contact the project maintainers at [insert contact information].

Acknowledgments

The project uses the following third-party libraries and frameworks:

• Flutter
• Sui
• Gradient Borders

We would like to thank the BSA x SUI EPFL Hackathon organizers and sponsors for this opportunity to showcase our project.