Skip to content

Conversation

@tomicz
Copy link
Contributor

@tomicz tomicz commented Oct 3, 2025

🎯 Purpose

This PR adds a simplified Unity sample project (Tomicz.SimpleExample.Unity) to complement the existing comprehensive sample.

🤔 Problem

While the existing Reown.AppKit.Unity sample is excellent for production applications, it can be overwhelming for developers who just want to:

  • Quickly understand core AppKit concepts
  • Get started with basic wallet integration
  • Learn the essential API patterns

💡 Solution

This new sample provides:

  • Single-file implementation - Everything in WalletController.cs
  • Essential features only - Connect, disconnect, get address/balance
  • Clear, copy-pasteable code - Easy to understand and adapt
  • Minimal dependencies - Just the core AppKit functionality

🎯 Target Audience

  • Developers new to Web3/Unity integration
  • Those who prefer learning through simple examples
  • Teams who want to quickly prototype wallet features

🤝 Relationship to Existing Sample

  • Existing sample: Production-ready, full-featured application
  • New sample: Learning-focused, minimal implementation
  • Both serve different purposes and complement each other

📚 Benefits

  • Faster developer onboarding
  • Clearer API documentation through code
  • Easier to understand core concepts
  • Better developer experience for quick integration

🔍 What's Included

  • Simple UI with essential buttons
  • Core AppKit initialization
  • Wallet connection/disconnection
  • Account and balance display
  • Clean, commented code

This sample doesn't replace the existing one but provides an alternative entry point for developers who prefer simpler examples.

tomicz added 2 commits October 3, 2025 06:05
- Add Tomicz.SimpleExample.Unity as a minimal, learning-focused sample
- Single WalletController.cs script with essential AppKit functionality
- Simple UI with connect/disconnect, account display, and balance
- Clear, copy-pasteable code for quick integration
- Complements existing comprehensive sample for different use cases
- Targets developers who prefer simpler examples when learning SDKs
@tomicz tomicz requested a review from skibitsky as a code owner October 3, 2025 04:11
@skibitsky skibitsky requested a review from Copilot October 8, 2025 05:30
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a simplified Unity sample project (Tomicz.SimpleExample.Unity) to provide developers with a minimal, learning-focused introduction to the Reown AppKit SDK. The sample complements the existing comprehensive Unity sample by offering essential wallet integration functionality in a single, easy-to-understand script.

  • Simplified Unity sample with essential features only (connect, disconnect, address/balance display)
  • Single-file implementation in WalletController.cs for easier understanding
  • Minimal dependencies and clear documentation via README and code comments

Reviewed Changes

Copilot reviewed 101 out of 106 changed files in this pull request and generated no comments.

File Description
sample/Tomicz.SimpleExample.Unity/README.md Comprehensive documentation explaining setup, features, and troubleshooting
sample/Tomicz.SimpleExample.Unity/ProjectSettings/* Unity project configuration files for the new sample
sample/Tomicz.SimpleExample.Unity/Packages/* Package management configuration including AppKit dependencies
sample/Tomicz.SimpleExample.Unity/Assets/TextMesh Pro/* TextMeshPro assets imported for UI text rendering

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@skibitsky
Copy link
Member

skibitsky commented Oct 8, 2025

Hello,

Thank you very much for opening the PR 🙏

I understand how newcomers may feel overwhelmed when learning a new tool, and our main sample may contribute to that. While I try to keep it as simple as possible, it still uses multiple scenes and includes some extra scripts, which contributes to complexity.

That said, we have many simpler sample projects in the /playground directory. The main differences between them and the sample are that the sample uses more AppKit features, is actively maintained, is utilized by CI, includes error monitoring tools, and its artifacts are distributed on TestFlight and Firebase.

Instead of introducing another sample project, we could link to one of our basic playground projects from the docs.

Our documentation already provides very detailed installation instructions and provides basic code snippets, as well as more in-depth examples in the Usage section. Do you think our doc aren't clear for newcomers?

I have also added a detailed readme file to the sample project.

@tomicz
Copy link
Contributor Author

tomicz commented Oct 8, 2025

Yes, I agree this would be a perfect addition to Playgrounds/ Do you want me to move it there, or will you do it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants