Skip to content

Commit 1b7dc8d

Browse files
authored
Unreal v2 Docs (#98)
* unreal v2 docs kickoff * separated unreal v1 images, added new Indexer images * started adding unreal guides section * new images for write-to-blockchain unreal section * latest unreal v2 changes * removed old images * moved unreal v1 to its own section * new boilerplate images, c++ integrations, architecture overview * started swaps and marketplace guides and docs sections for checkout, marketplace, swaps * updated docs.json * latest updates * latest unreal v2 updates * set chain by id, marketplace guide, few changes * description for wallet linking in unreal * fixed broken links * fix for unreal translations, lowered some image resolutions * fixed broken links in translations * fixing broken links in translations * fixing broken links * fixing broken links * fixing broken link
1 parent db32b94 commit 1b7dc8d

File tree

213 files changed

+3372
-905
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

213 files changed

+3372
-905
lines changed

api-references/indexer/installation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,5 +85,5 @@ _, tokenBalances, err := seqIndexer.GetTokenBalances(context.Background(), &acco
8585

8686
### Unity or Unreal Installation
8787

88-
The Sequence Indexer is integrated directly inside of the respective [Sequence Unity](/sdk/unity/) and [Sequence Unreal](/sdk/unreal/introduction) SDKs.
88+
The Sequence Indexer is integrated directly inside of the respective [Sequence Unity](/sdk/unity/) and [Sequence Unreal](/sdk/unreal/overview) SDKs.
8989

api-references/metadata/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ contractInfo, err := seqMetadata.GetContractInfo(context.Background(), "polygon"
5656

5757
### Unity or Unreal Installation
5858

59-
The Sequence Metadata is integrated directly inside of the respective [Sequence Unity](/sdk/unity/overview) and [Sequence Unreal](/sdk/unreal/introduction) SDKs.
59+
The Sequence Metadata is integrated directly inside of the respective [Sequence Unity](/sdk/unity/overview) and [Sequence Unreal](/sdk/unreal/overview) SDKs.

docs.json

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -371,19 +371,52 @@
371371
{
372372
"group": "Unreal",
373373
"pages": [
374-
"sdk/unreal/introduction",
375-
"sdk/unreal/quickstart",
374+
"sdk/unreal/overview",
376375
"sdk/unreal/installation",
377-
"sdk/unreal/configuration",
378-
"sdk/unreal/subsystems",
376+
"sdk/unreal/getting_started",
379377
"sdk/unreal/bootstrap_game",
380-
"sdk/unreal/user_interfaces",
381-
"sdk/unreal/authentication",
382-
"sdk/unreal/write-to-blockchain",
383-
"sdk/unreal/read-from-blockchain",
384-
"sdk/unreal/onboard-user-funds",
385-
"sdk/unreal/advanced",
386-
"sdk/unreal/platforms"
378+
"sdk/unreal/migration",
379+
{
380+
"group": "Guides",
381+
"pages": [
382+
"sdk/unreal/guides/social-signin-guide",
383+
"sdk/unreal/guides/marketplace-guide",
384+
"sdk/unreal/guides/swaps-guide"
385+
]
386+
},
387+
{
388+
"group": "Onboarding",
389+
"pages": [
390+
"sdk/unreal/onboarding/authentication",
391+
"sdk/unreal/onboarding/manage_sessions",
392+
"sdk/unreal/onboarding/wallet_linking"
393+
]
394+
},
395+
{
396+
"group": "Power",
397+
"pages": [
398+
"sdk/unreal/power/write-to-blockchain",
399+
"sdk/unreal/power/read-from-blockchain",
400+
"sdk/unreal/power/smart-contracts"
401+
]
402+
},
403+
{
404+
"group": "Monetization",
405+
"pages": [
406+
"sdk/unreal/monetization/secondary-sales-marketplace",
407+
"sdk/unreal/monetization/checkout",
408+
"sdk/unreal/monetization/currency-swaps",
409+
"sdk/unreal/monetization/onboard-user-funds"
410+
]
411+
},
412+
{
413+
"group": "Advanced",
414+
"pages": [
415+
"sdk/unreal/advanced/utilities",
416+
"sdk/unreal/advanced/advanced",
417+
"sdk/unreal/advanced/platforms"
418+
]
419+
}
387420
]
388421
}
389422
]

es/guides/unreal-ew-guide.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Si no, comience instalando Epic Games Launcher:
2929
## Descargue el SDK de Unreal Engine de Sequence
3030
Para comenzar, descargue la [última versión](https://github.com/0xsequence/sequence-unreal/releases) del SDK de Sequence y coloque la carpeta `SequencePlugin` en la carpeta `Plugin` de su proyecto Unreal.
3131

32-
Alternativamente, [obtenga el SDK desde el Epic Games Marketplace.](/sdk/unreal/installation#using-epic-games-marketplace)
32+
Alternativamente, [obtenga el SDK desde el Epic Games Marketplace.](/es/sdk/unreal/installation#using-epic-games-marketplace)
3333

3434
### Configure su proyecto
3535

@@ -46,11 +46,11 @@ Alternativamente, [obtenga el SDK desde el Epic Games Marketplace.](/sdk/unreal/
4646
### Inicie sesión usando la interfaz integrada
4747
En el blueprint del nivel del menú principal, generaremos nuestro Actor `Sequence Connector`, que iniciará y mostrará el panel de inicio de sesión.
4848

49-
Recomendamos usar la interfaz integrada para fines de desarrollo. Aquí tiene una [explicación más detallada.](/sdk/unreal/user_interfaces/)
50-
Para mayor personalización, [aprenda cómo crear su propia interfaz.](/sdk/unreal/authentication/)
49+
Recomendamos usar la interfaz integrada para fines de desarrollo. Aquí tiene una [explicación más detallada.](/sdk/unreal/v1/user_interfaces/)
50+
Para mayor personalización, [aprenda cómo crear su propia interfaz.](/es/sdk/unreal/authentication/)
5151

5252
## 2. Configuración del Network Id y la cadena
53-
Para comenzar nuestra interacción con el SDK de Sequence, abra el _Sequence Connector_ blueprint, localice el evento `Auth Success` en _Event Graph > Begin Play_, y llamaremos a `Api Update Network Id` desde el Subsystem SequenceWalletBP para configurar el wallet en la red seleccionada de su proyecto en Builder.
53+
Para comenzar nuestra interacción con el SDK de Sequence, abra el _Sequence Connector_ blueprint, localice el evento `Auth Success` en _Event Graph > Begin Play_, y llamaremos a `Api Update Network Id` desde el Subsystem SequenceWalletBP para configurar el wallet en la red seleccionada de su proyecto en Builder.
5454
En el mismo evento, también llamaremos a `Set Chain` desde el Subsystem Sequence Indexer para poder obtener correctamente los assets.
5555

5656
## 3. Obtener dirección del Wallet
@@ -75,7 +75,7 @@ Para obtener los NFTs del jugador, usaremos el Subsystem Indexer para llamar a `
7575
### Quemar los NFTs del jugador
7676
Para dar al jugador las recompensas por usar uno de nuestros NFTs, usaremos el subsistema SequenceSDK para crear y enviar una transacción `Burn` del `Web 3 Game Item` deseado, lo que nos devolverá el estado de la transacción y la dirección del contrato, para verificar el éxito del quemado del ítem. Si es exitoso, usaremos las propiedades del contrato para dar al jugador su recompensa. Esto lo encontrará en el blueprint `CUI_VaultItem`.
7777

78-
Para una explicación más detallada, vaya a las secciones [Leer desde Blockchain](/sdk/unreal/read-from-blockchain/) y [Escribir en Blockchain](/sdk/unreal/write-to-blockchain/).
78+
Para una explicación más detallada, vaya a las secciones [Leer desde Blockchain](/es/sdk/unreal/read-from-blockchain/) y [Escribir en Blockchain](/sdk/unreal/v1/write-to-blockchain/).
7979

8080
## 5. Cerrar sesión del jugador
8181
Para cerrar la sesión del jugador y terminar su sesión, llamaremos a `Clear Session` del Sequence Sessions Subsystem, de esta manera eliminaremos sus credenciales almacenadas y el usuario deberá iniciar sesión nuevamente cuando regrese. Llamaremos a este método en el UI\_Layer\_Menu.

es/sdk/headless-wallet/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Conecte a sus usuarios con su App usando Sequence Embedded Wallet.
44
sidebarTitle: Inicio rápido
55
---
66

7-
Para integración con Unreal o Unity, vaya a [Unreal](/sdk/unreal/quickstart) o [Unity](/sdk/unity/installation).
7+
Para integración con Unreal o Unity, vaya a [Unreal](/es/sdk/unreal/quickstart) o [Unity](/sdk/unity/installation).
88

99
<Steps>
1010
<Step title="Clonar repositorio inicial">

es/sdk/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Sequence ofrece múltiples SDKs para ayudar a integrar funcionalidad blockchain
5454
</div>
5555
</a>
5656

57-
<a className="card block not-prose font-normal group relative my-2 ring-2 ring-transparent rounded-2xl bg-white dark:bg-background-dark border border-gray-950/10 dark:border-white/10 overflow-hidden w-full cursor-pointer hover:!border-primary dark:hover:!border-primary-light" href="/sdk/unreal/introduction">
57+
<a className="card block not-prose font-normal group relative my-2 ring-2 ring-transparent rounded-2xl bg-white dark:bg-background-dark border border-gray-950/10 dark:border-white/10 overflow-hidden w-full cursor-pointer hover:!border-primary dark:hover:!border-primary-light" href="/es/sdk/unreal/introduction">
5858
<div className="px-6 py-5">
5959
<div className="h-6 w-6 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100">
6060
<div
@@ -144,7 +144,7 @@ Elija el SDK que mejor se adapte a su plataforma y necesidades de desarrollo:
144144

145145
Para desarrollo de juegos:
146146
- Use el [Unity SDK](/sdk/unity/overview) para juegos en Unity
147-
- Use el [SDK de Unreal](/sdk/unreal/introduction) para juegos en Unreal Engine
147+
- Use el [SDK de Unreal](/es/sdk/unreal/introduction) para juegos en Unreal Engine
148148
Para servicios de backend, consulte el [SDK de Go](/sdk/go/overview)
149149
Para aplicaciones móviles, explore el [SDK de React Native](/sdk/mobile)
150150

es/sdk/unreal/authentication.mdx

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Autenticación de usuarios
33
description: Documentación para la API del SDK de Unreal para gestionar sesiones en la infraestructura de Sequence orientada a juegos web3.
44
---
55

6-
Visite nuestra página de [Requisitos de Plataforma](/sdk/unreal/platforms) para información detallada sobre la configuración y para asegurarse
6+
Visite nuestra página de [Requisitos de Plataforma](/es/sdk/unreal/platforms) para información detallada sobre la configuración y para asegurarse
77
de que los métodos de autenticación que elija estén correctamente configurados en su proyecto de Builder.
88

99
## Iniciar sesión con OTP por correo electrónico
@@ -13,27 +13,27 @@ Escuche el evento Email Requires Code.
1313
<Tabs>
1414
<Tab title="Blueprint">
1515
<Frame>
16-
<img src="/images/unreal/email_otp.png" />
16+
<img src="/images/unreal/v1/email_otp.png" />
1717
</Frame>
1818
</Tab>
1919
</Tabs>
2020

2121
## Inicio de sesión con redes sociales
22-
Para iniciar la autenticación basada en SSO en escritorio, debe navegar a un navegador para obtener el id\_token necesario.
22+
Para iniciar la autenticación basada en SSO en escritorio, debe navegar a un navegador para obtener el id\_token necesario.
2323
En dispositivos móviles, nuestro SDK maneja este proceso por usted utilizando plugins integrados.
2424

25-
En plataformas de escritorio, escuche el evento `Sign in Web View Required` y abra la `Sign In URL` que se retorna.
25+
En plataformas de escritorio, escuche el evento `Sign in Web View Required` y abra la `Sign In URL` que se retorna.
2626
En plataformas móviles, escuche el evento `Id Token Received`.
2727

28-
Cuando llame a las funciones de `Sign In`, escuche el evento `Session Established` en el subsistema `SequenceSessionsBP`
28+
Cuando llame a las funciones de `Sign In`, escuche el evento `Session Established` en el subsistema `SequenceSessionsBP`
2929
para saber cuándo la solicitud de inicio de sesión fue exitosa. Escuche `Session Creation Failure` si ocurre algún error.
3030

3131
### Obtener Google Id Token
3232

3333
<Tabs>
3434
<Tab title="Blueprint">
3535
<Frame>
36-
<img src="/images/unreal/google_idtoken.png" />
36+
<img src="/images/unreal/v1/google_idtoken.png" />
3737
</Frame>
3838
</Tab>
3939
</Tabs>
@@ -43,13 +43,13 @@ para saber cuándo la solicitud de inicio de sesión fue exitosa. Escuche `Sessi
4343
<Tabs>
4444
<Tab title="Blueprint">
4545
<Frame>
46-
<img src="/images/unreal/apple_idtoken.png" />
46+
<img src="/images/unreal/v1/apple_idtoken.png" />
4747
</Frame>
4848
</Tab>
4949
</Tabs>
5050

5151
### Iniciar sesión con Google
52-
Inicie sesión con un Google Id Token válido. Puede obtenerlo desde el nodo [Get Google Id Token](/sdk/unreal/authentication#get-google-id-token).
52+
Inicie sesión con un Google Id Token válido. Puede obtenerlo desde el nodo [Get Google Id Token](/es/sdk/unreal/authentication#get-google-id-token).
5353

5454
<Tabs>
5555
<Tab title="Blueprint">
@@ -60,7 +60,7 @@ Inicie sesión con un Google Id Token válido. Puede obtenerlo desde el nodo [Ge
6060
</Tabs>
6161

6262
### Iniciar sesión con Apple
63-
Inicie sesión con un Apple Id Token válido. Puede obtenerlo desde el nodo [Get Apple Id Token](/sdk/unreal/authentication#get-apple-id-token).
63+
Inicie sesión con un Apple Id Token válido. Puede obtenerlo desde el nodo [Get Apple Id Token](/es/sdk/unreal/authentication#get-apple-id-token).
6464

6565
<Tabs>
6666
<Tab title="Blueprint">
@@ -87,14 +87,14 @@ Utilice este método para iniciar una sesión usando un Id token válido de Goog
8787
<Tabs>
8888
<Tab title="Blueprint">
8989
<Frame>
90-
<img src="/images/unreal/token_session.png" />
90+
<img src="/images/unreal/v1/token_session.png" />
9191
</Frame>
9292
</Tab>
9393
</Tabs>
9494

9595
## PlayFab
96-
Deberá incluir su PlayFab Title ID en el archivo `SequenceConfig.ini`
97-
durante la [Configuración](/sdk/unreal/configuration) y [configurar PlayFab en el Builder](/solutions/builder/embedded-wallet/playfab-configuration).
96+
Deberá incluir su PlayFab Title ID en el archivo `SequenceConfig.ini`
97+
durante la [Configuración](/es/sdk/unreal/configuration) y [configurar PlayFab en el Builder](/solutions/builder/embedded-wallet/playfab-configuration).
9898

9999
### Registrar un nuevo usuario de PlayFab
100100

@@ -111,7 +111,7 @@ durante la [Configuración](/sdk/unreal/configuration) y [configurar PlayFab en
111111
<Tabs>
112112
<Tab title="Blueprint">
113113
<Frame>
114-
<img src="/images/unreal/playfab_login.png" />
114+
<img src="/images/unreal/v1/playfab_login.png" />
115115
</Frame>
116116
</Tab>
117117
</Tabs>
@@ -125,28 +125,28 @@ Puede iniciar sesión a los usuarios como invitados. Sin embargo, tenga en cuent
125125
<Tabs>
126126
<Tab title="Blueprint">
127127
<Frame>
128-
<img src="/images/unreal/guest_session.png" />
128+
<img src="/images/unreal/v1/guest_session.png" />
129129
</Frame>
130130
</Tab>
131131
</Tabs>
132132

133133
## Federar cuentas
134-
Con las Cuentas Federadas, puede asociar múltiples métodos de inicio de sesión con una sola cuenta y wallet.
135-
Si su usuario ha iniciado sesión como invitado, definitivamente querrá motivarlo a federar su
136-
cuenta para que tenga credenciales persistentes con las que pueda acceder a su Sequence Embedded Wallet en sesiones futuras.
134+
Con las Cuentas Federadas, puede asociar múltiples métodos de inicio de sesión con una sola cuenta y wallet.
135+
Si su usuario ha iniciado sesión como invitado, definitivamente querrá motivarlo a federar su
136+
cuenta para que tenga credenciales persistentes con las que pueda acceder a su Sequence Embedded Wallet en sesiones futuras.
137137
Mientras el usuario esté autenticado con la API de Sequence, puede agregar un método de inicio de sesión adicional usando la llamada correspondiente para federar la cuenta.
138138

139139
<Tabs>
140140
<Tab title="Blueprint">
141141
<Frame>
142-
<img src="/images/unreal/email_federation.png" />
142+
<img src="/images/unreal/v1/email_federation.png" />
143143
</Frame>
144144
</Tab>
145145
</Tabs>
146146

147147
## Obtener Id Token
148-
Un caso de uso común es verificar la identidad del usuario en su backend después de que el usuario haya completado el proceso de inicio de sesión en su app cliente.
149-
Obtenga un Sequence Id Token de sus usuarios para enviarlo a su backend y verificarlo usando cualquier librería JWKS.
148+
Un caso de uso común es verificar la identidad del usuario en su backend después de que el usuario haya completado el proceso de inicio de sesión en su app cliente.
149+
Obtenga un Sequence Id Token de sus usuarios para enviarlo a su backend y verificarlo usando cualquier librería JWKS.
150150
Lea nuestra [Guía de Verificación Backend](/sdk/headless-wallet/verification) para más información.
151151

152152
<Tabs>
@@ -158,14 +158,14 @@ Lea nuestra [Guía de Verificación Backend](/sdk/headless-wallet/verification)
158158

159159
<Tab title="C++">
160160
```cpp
161-
const TFunction<void (FSeqIdTokenResponse_Data)> OnSuccess = [this](const FSeqIdTokenResponse_Data& Data) { };
162-
const TFunction<void (FSequenceError)> OnFailure = [this](const FSequenceError& Err){ };
163-
164-
const TOptional<USequenceWallet*> WalletOptional = USequenceWallet::Get();
165-
if (WalletOptional.IsSet() && WalletOptional.GetValue())
166-
{
167-
const USequenceWallet* Wallet = WalletOptional.GetValue();
168-
Wallet->GetIdToken(Nonce, OnSuccess, OnFailure);
161+
const TFunction<void (FSeqIdTokenResponse_Data)> OnSuccess = [this](const FSeqIdTokenResponse_Data& Data) { };
162+
const TFunction<void (FSequenceError)> OnFailure = [this](const FSequenceError& Err){ };
163+
164+
const TOptional<USequenceWallet*> WalletOptional = USequenceWallet::Get();
165+
if (WalletOptional.IsSet() && WalletOptional.GetValue())
166+
{
167+
const USequenceWallet* Wallet = WalletOptional.GetValue();
168+
Wallet->GetIdToken(Nonce, OnSuccess, OnFailure);
169169
}
170170
```
171171
</Tab>
@@ -177,17 +177,17 @@ Borre el caché de credenciales y cierre la sesión del usuario actual.
177177
<Tabs>
178178
<Tab title="Blueprint">
179179
<Frame>
180-
<img src="/images/unreal/sign_out.png" />
180+
<img src="/images/unreal/v1/sign_out.png" />
181181
</Frame>
182182
</Tab>
183183

184184
<Tab title="C++">
185185
```cpp
186-
const TOptional<USequenceWallet*> WalletOptional = USequenceWallet::Get();
187-
if (WalletOptional.IsSet() && WalletOptional.GetValue())
188-
{
189-
USequenceWallet * Api = WalletOptional.GetValue();
190-
Api->SignOut();
186+
const TOptional<USequenceWallet*> WalletOptional = USequenceWallet::Get();
187+
if (WalletOptional.IsSet() && WalletOptional.GetValue())
188+
{
189+
USequenceWallet * Api = WalletOptional.GetValue();
190+
Api->SignOut();
191191
}
192192
```
193193
</Tab>
@@ -199,25 +199,25 @@ Lista las sesiones activas.
199199
<Tabs>
200200
<Tab title="Blueprint">
201201
<Frame>
202-
<img src="/images/unreal/list_sessions.png" />
202+
<img src="/images/unreal/v1/list_sessions.png" />
203203
</Frame>
204204
</Tab>
205205

206206
<Tab title="C++">
207207
```cpp
208-
const TSuccessCallback<TArray<FSession>> OnSuccess = [=](TArray<FSession> Response)
209-
{
210-
//Response is a list of Sessions
211-
};
212-
const FFailureCallback OnFailure = [=](const FSequenceError& Error)
213-
{
214-
UE_LOG(LogTemp,Display,TEXT("Error Message: %s"),*Error.Message);
215-
};
216-
const TOptional<USequenceWallet*> WalletOptional = USequenceWallet::Get();
217-
if (WalletOptional.IsSet() && WalletOptional.GetValue())
218-
{
219-
USequenceWallet * Api = WalletOptional.GetValue();
220-
Api->ListSessions(OnSuccess,OnFailure);
208+
const TSuccessCallback<TArray<FSession>> OnSuccess = [=](TArray<FSession> Response)
209+
{
210+
//Response is a list of Sessions
211+
};
212+
const FFailureCallback OnFailure = [=](const FSequenceError& Error)
213+
{
214+
UE_LOG(LogTemp,Display,TEXT("Error Message: %s"),*Error.Message);
215+
};
216+
const TOptional<USequenceWallet*> WalletOptional = USequenceWallet::Get();
217+
if (WalletOptional.IsSet() && WalletOptional.GetValue())
218+
{
219+
USequenceWallet * Api = WalletOptional.GetValue();
220+
Api->ListSessions(OnSuccess,OnFailure);
221221
}
222222
```
223223
</Tab>

0 commit comments

Comments
 (0)