Merge pull request #185 from okto-hq/main

unity docs
okto-hq · Dec 11, 2024 · 7687a80 · 7687a80
2 parents 5fba9c7 + 50ff485
commit 7687a80
Show file tree

Hide file tree

Showing 8 changed files with 226 additions and 20 deletions.
diff --git a/app/components/Navbar.tsx b/app/components/Navbar.tsx
@@ -15,6 +15,7 @@ import { ChevronDown } from 'lucide-react';
 import { FaReact } from "react-icons/fa6";
 import { TbBrandReactNative, TbApi } from "react-icons/tb";
 import { SiFlutter } from "react-icons/si";
+import { FaUnity } from "react-icons/fa6";
 import { useTheme } from "next-themes";
 import GitHubButton from "./GithubButton";
 import DiscordButton from "./DiscordButton";
@@ -52,6 +53,7 @@ export default function NavbarComponent() {
     { href: "/docs/react-sdk", label: "React", subpath: '/getting-started/overview-okto-react', icons: <FaReact /> },
     { href: "/docs/react-native-sdk", label: "React Native", subpath: '/getting-started/overview-okto-react-native', icons: <TbBrandReactNative /> },
     { href: "/docs/flutter-sdk", label: "Flutter", subpath: '/getting-started/overview-okto-flutter', icons: <SiFlutter /> },
+    { href: "/docs", label: "Unity", subpath: '/unity-sdk', icons: <FaUnity /> },
   ];
 
   const getFrameworkLabel = () => {

diff --git a/content/docs/flutter-sdk/getting-started/overview-okto-flutter.mdx b/content/docs/flutter-sdk/getting-started/overview-okto-flutter.mdx
@@ -3,10 +3,22 @@ title: Overview of the Okto Flutter SDK
 description: Flutter SDK for Okto
 ---
 
+import TechnologyCard from 'app/components/mdx/TechnologyCard';
+import { IoCodeSlashOutline } from "react-icons/io5";
+
 ## Introduction to Okto Flutter SDK
 
 The **Okto Flutter SDK** offers a streamlined solution for integrating Web3 functionalities into your Flutter application. With minimal setup time, you can effortlessly onboard your users to the Web3 ecosystem and provide them with a seamless experience.
 
+<div className="my-6">
+  <TechnologyCard
+    icon={<IoCodeSlashOutline size={"1.5rem"} />}
+    title="GitHub Repository"
+    subtitle="Checkout the SDK Source Code"
+    link="https://github.com/okto-hq/okto-sdk-flutter"
+  />
+</div>
+
 ### Quick Setup
 
 With just ten minutes of setup, the Okto Flutter SDK provides:

diff --git a/content/docs/index.mdx b/content/docs/index.mdx
@@ -14,6 +14,7 @@ import SDKCard from "../../app/components/mdx/SDKCard";
 import Footer from "../../app/components/Footer";
 import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
 import { FaReact } from "react-icons/fa6";
+import { FaUnity } from "react-icons/fa6";
 import { MessageSquareText, MousePointer2 } from 'lucide-react';
 import { TbBrandReactNative, TbApi } from "react-icons/tb";
 import { SiFlutter } from "react-icons/si";
@@ -88,6 +89,13 @@ Pick the right SDK for your platform and start integrating Web3 features:
       link="/api-docs"
   />
 
+  <TechnologyCard 
+      icon={<FaUnity size={"3rem"} />}
+      title="Unity"
+      subtitle="for Web3-enabled gaming experiences"
+      link="/docs/unity-sdk"
+  />
+
 </div>
 
 ## Learn More 

diff --git a/content/docs/meta.json b/content/docs/meta.json
@@ -11,6 +11,7 @@
       "react-sdk",
       "flutter-sdk",
       "react-native-sdk",
+      "unity-sdk",
       "---Resources---",
       "brand-kit",
       "[Showcase](https://docs.okto.tech/showcase)",

diff --git a/content/docs/react-native-sdk/getting-started/overview-okto-react-native.mdx b/content/docs/react-native-sdk/getting-started/overview-okto-react-native.mdx
@@ -4,10 +4,22 @@ description: The Okto React Native SDK is the easiest way to onboard your users
 full: false
 ---
 
+import TechnologyCard from 'app/components/mdx/TechnologyCard';
+import { IoCodeSlashOutline } from "react-icons/io5";
+
 ## Introduction to Okto React Native SDK
 
 The **Okto React Native SDK** offers a streamlined solution for integrating Web3 functionalities into your React Native application. With minimal setup time, you can effortlessly onboard your users to the Web3 ecosystem and provide them with a seamless experience.
 
+<div className="my-6">
+  <TechnologyCard
+    icon={<IoCodeSlashOutline size={"1.5rem"} />}
+    title="GitHub Repository"
+    subtitle="Checkout the SDK Source Code"
+    link="https://github.com/okto-hq/okto-sdk-react-native"
+  />
+</div>
+
 ### Quick Setup
 
 With just ten minutes of setup, the Okto React Native SDK provides:

diff --git a/content/docs/react-sdk/getting-started/overview-okto-react.mdx b/content/docs/react-sdk/getting-started/overview-okto-react.mdx
@@ -4,10 +4,22 @@ description: The Okto React SDK is the easiest way to onboard your users to web3
 full: false
 ---
 
+import TechnologyCard from 'app/components/mdx/TechnologyCard';
+import { IoCodeSlashOutline } from "react-icons/io5";
+
 ## Introduction to Okto React SDK
 
 The **Okto React SDK** offers a streamlined solution for integrating Web3 functionalities into your React application. With minimal setup time, you can effortlessly onboard your users to the Web3 ecosystem and provide them with a seamless experience.
 
+<div className="my-6">
+  <TechnologyCard
+    icon={<IoCodeSlashOutline size={"1.5rem"} />}
+    title="GitHub Repository"
+    subtitle="Checkout the SDK Source Code"
+    link="https://github.com/okto-hq/okto-sdk-react"
+  />
+</div>
+
 ### Quick Setup
 
 With just ten minutes of setup, the Okto React SDK provides:

diff --git a/content/docs/sdk-overview.mdx b/content/docs/sdk-overview.mdx
@@ -4,49 +4,163 @@ description: Okto provides a suite of SDKs tailored to different platforms, enab
 full: false
 ---
 
+import TechnologyCard from "../../app/components/mdx/TechnologyCard";
+import { IoBookOutline, IoCodeSlashOutline, IoRocketOutline, IoAppsOutline } from "react-icons/io5";
+
 ## 1. **React SDK**
 The React SDK is designed for developers building Web3 applications for the web. It simplifies blockchain interactions, enabling seamless onboarding and smooth user experiences.
 
-- **Use Case**: Web applications.
-- [Learn more about React SDK](/docs/react-sdk/getting-started/overview-okto-react)
-- [Quick Start Guide](/docs/react-sdk/getting-started/overview-okto-react)
-- [Template App](https://github.com/okto-hq/okto-sdk-react-template-app)
+**Use Case**: Web applications
+
+<div className="grid grid-cols-1 md:grid-cols-2 gap-3 md:gap-6 lg:gap-8">
+  <TechnologyCard
+    icon={<IoBookOutline size={"1.5rem"} />}
+    title="Learn More"
+    subtitle="Explore React SDK documentation"
+    link="/docs/react-sdk/getting-started/overview-okto-react"
+  />
+
+  <TechnologyCard
+    icon={<IoCodeSlashOutline size={"1.5rem"} />}
+    title="GitHub Repository"
+    subtitle="Access the source code"
+    link="https://github.com/okto-hq/okto-sdk-react"
+  />
+
+  <TechnologyCard
+    icon={<IoRocketOutline size={"1.5rem"} />}
+    title="Quick Start Guide"
+    subtitle="Get up and running quickly"
+    link="/docs/react-sdk/getting-started/overview-okto-react"
+  />
+
+  <TechnologyCard
+    icon={<IoAppsOutline size={"1.5rem"} />}
+    title="Template App"
+    subtitle="Example implementation"
+    link="https://github.com/okto-hq/okto-sdk-react-template-app"
+  />
+</div>
 
 ---
 
 ## 2. **React Native SDK**
 If you’re developing mobile-first Web3 applications, the React Native SDK is your go-to option. It provides all the tools necessary to onboard users to Web3 seamlessly.
 
-- **Use Case**: Mobile applications for iOS and Android.
-- [Learn more about React Native SDK](/docs/react-native-sdk/getting-started/overview-okto-react-native)
-- [Quick Start Guide](/docs/react-native-sdk/getting-started/overview-okto-react-native)
-- [Template App](https://github.com/okto-hq/okto-sdk-reactnative-template-app)
+**Use Case**: Mobile applications for iOS and Android
+
+<div className="grid grid-cols-1 md:grid-cols-2 gap-3 md:gap-6 lg:gap-8">
+  <TechnologyCard
+    icon={<IoBookOutline size={"1.5rem"} />}
+    title="Learn More"
+    subtitle="Explore React Native SDK documentation"
+    link="/docs/react-native-sdk/getting-started/overview-okto-react-native"
+  />
+
+  <TechnologyCard
+    icon={<IoCodeSlashOutline size={"1.5rem"} />}
+    title="GitHub Repository"
+    subtitle="Access the source code"
+    link="https://github.com/okto-hq/okto-sdk-react-native"
+  />
+
+  <TechnologyCard
+    icon={<IoRocketOutline size={"1.5rem"} />}
+    title="Quick Start Guide"
+    subtitle="Get up and running quickly"
+    link="/docs/react-native-sdk/getting-started/overview-okto-react-native"
+  />
+
+  <TechnologyCard
+    icon={<IoAppsOutline size={"1.5rem"} />}
+    title="Template App"
+    subtitle="Example implementation"
+    link="https://github.com/okto-hq/okto-sdk-reactnative-template-app"
+  />
+</div>
 
 ---
 
 ## 3. **Flutter SDK**
 The Flutter SDK caters to developers using Flutter and Dart to build cross-platform mobile applications. It reduces setup complexity and enhances user experiences.
 
-- **Use Case**: Cross-platform mobile applications (Android and iOS).
-- [Learn more about Flutter SDK](/docs/flutter-sdk/getting-started/overview-okto-flutter)
-- [Quick Start Guide](/docs/flutter-sdk/getting-started/overview-okto-flutter)
-- [Template App](https://github.com/okto-hq/okto-sdk-flutter-template-app)
+**Use Case**: Cross-platform mobile applications (Android and iOS)
+
+<div className="grid grid-cols-1 md:grid-cols-2 gap-3 md:gap-6 lg:gap-8">
+  <TechnologyCard
+    icon={<IoBookOutline size={"1.5rem"} />}
+    title="Learn More"
+    subtitle="Explore Flutter SDK documentation"
+    link="/docs/flutter-sdk/getting-started/overview-okto-flutter"
+  />
+
+  <TechnologyCard
+    icon={<IoCodeSlashOutline size={"1.5rem"} />}
+    title="GitHub Repository"
+    subtitle="Access the source code"
+    link="https://github.com/okto-hq/okto-sdk-flutter"
+  />
+
+  <TechnologyCard
+    icon={<IoRocketOutline size={"1.5rem"} />}
+    title="Quick Start Guide"
+    subtitle="Get up and running quickly"
+    link="/docs/flutter-sdk/getting-started/overview-okto-flutter"
+  />
+
+  <TechnologyCard
+    icon={<IoAppsOutline size={"1.5rem"} />}
+    title="Template App"
+    subtitle="Example implementation"
+    link="https://github.com/okto-hq/okto-sdk-flutter-template-app"
+  />
+</div>
 
 ---
 
-## 4. **API Integration**
-For projects that don’t rely on specific frameworks, the Okto API provides a direct way to integrate Web3 functionalities. Use it to build custom solutions for your unique needs.
+## 4. **Unity SDK**
+The Unity SDK will empower game developers to integrate Web3 features into their games across platforms such as web, mobile, and desktop.
 
-- **Use Case**: Server-side or client-side Web3 applications without framework dependencies.
-- [API Documentation](/api-docs)
+**Use Case**: Web3-enabled gaming experiences
+
+<div className="grid grid-cols-1 md:grid-cols-2 gap-3 md:gap-6 lg:gap-8">
+  <TechnologyCard
+    icon={<IoBookOutline size={"1.5rem"} />}
+    title="Learn More"
+    subtitle="Explore Unity SDK documentation"
+    link="/docs/unity-sdk"
+  />
+
+  <TechnologyCard
+    icon={<IoCodeSlashOutline size={"1.5rem"} />}
+    title="GitHub Repository"
+    subtitle="Access the source code"
+    link="https://github.com/okto-hq/okto-sdk-unity"
+  />
+
+  <TechnologyCard
+    icon={<IoRocketOutline size={"1.5rem"} />}
+    title="Cheatsheet"
+    subtitle="Setup instructions & examples"
+    link="https://docs.google.com/document/d/1V7guvCvgYzjKsJUK9xKRdSPSbg3RAoC0Bu_AnH9t7Og/edit?usp=sharing"
+  />
+</div>
 
 ---
 
-## 5. **Unity SDK (Coming Soon)**
-The Unity SDK will empower game developers to integrate Web3 features into their games across platforms such as web, mobile, and desktop.
+## 5. **API Integration**
+For projects that don’t rely on specific frameworks, the Okto API provides a direct way to integrate Web3 functionalities. Use it to build custom solutions for your unique needs.
+
+**Use Case**: Server-side or client-side Web3 applications without framework dependencies
 
-- **Use Case**: Web3-enabled gaming experiences.
-- Stay tuned for updates!
+<div className="grid grid-cols-1 md:grid-cols-2 gap-3 md:gap-6 lg:gap-8">
+  <TechnologyCard
+    icon={<IoBookOutline size={"1.5rem"} />}
+    title="API Documentation"
+    subtitle="Explore the API reference"
+    link="/api-docs"
+  />
+</div>
 
 ---
 

diff --git a/content/docs/unity-sdk.mdx b/content/docs/unity-sdk.mdx
@@ -0,0 +1,45 @@
+---
+title: Unity
+full: false
+---
+
+import { Callout } from 'fumadocs-ui/components/callout';
+
+<Callout title="Disclaimer">
+The Unity SDK is a community-built integration and is not officially maintained by Okto. At present, the SDK only supports mobile application development.
+</Callout>
+
+The **Okto Unity SDK** enables developers to integrate blockchain functionality into their Unity-based mobile games and applications. With this SDK, you can add features like:
+
+- User authentication (Google OAuth, Email OTP, Phone OTP)
+- Wallet management
+- Token and NFT operations
+- Smart contract interactions
+- Portfolio tracking
+
+## Resources
+
+| Resource | Description | Link |
+|----------|-------------|------|
+| Unity SDK GitHub Repository | Source code and SDK files | [View on GitHub](https://github.com/okto-hq/okto-sdk-unity) |
+| Documentation & Cheatsheet | Complete setup guide and usage examples | [View Guide](https://docs.google.com/document/d/1V7guvCvgYzjKsJUK9xKRdSPSbg3RAoC0Bu_AnH9t7Og/edit?usp=sharing) |
+
+## Unity SDK Packages
+
+| Package | Version | Description | Download |
+|---------|---------|-------------|----------|
+| Unity SDK Package | 1.0 | Core SDK package including all necessary files and plugins | [Download package](https://github.com/okto-hq/okto-sdk-unity/raw/main/OktoSDKFile/UnitySdk_1.0.unitypackage) |
+
+## Getting Started
+
+1. Download the Unity SDK package from the table above.
+2. Check out our [comprehensive documentation](https://docs.google.com/document/d/1V7guvCvgYzjKsJUK9xKRdSPSbg3RAoC0Bu_AnH9t7Og/edit?usp=sharing) for:
+   - Step-by-step setup instructions
+   - Code examples for each feature
+
+## Community and Support
+
+The Unity SDK is maintained by the community. For support:
+
+- Report issues on [GitHub](https://github.com/okto-hq/okto-sdk-unity/issues)
+- Submit pull requests for improvements