Forem: Eduardo Queiróz

Generating Engagement for Indie Games with OpenAPI + Twitter API + Azure Logic Apps (EN/US)

Eduardo Queiróz — Fri, 26 May 2023 16:51:05 +0000

Briefing

In summary, game development is not my main activity. It's a hobby that I mainly pursue during my free time at DZ9 Games, during sleepless nights, or on weekends. However, I realized that this journey was becoming impossible to pursue alone, so I decided to invite an illustrator and a scriptwriter to join the #theagent team, both of whom eagerly accepted the challenge.

If you want to know more details about the game and its progress, you can find them here, here, or here.

The Problem

As the Demo version (which is currently in progress) approaches, we are starting to work on social media and explore potential marketing channels. However, we face a challenge as nobody on the team is dedicated full-time to this role. The time required for this "marketing," "advertising," and "engagement" work directly conflicts with tweaking game mechanics, artwork, and overall improvements.

Once again, it is impossible to juggle and accomplish all these tasks with a minimum level of quality.

The Solution Was Close

During the development phase, we faced the need to solve our marketing challenges. We considered various options, such as hiring an agency, a social media specialist, or even an intern, but these alternatives mainly involved additional costs 😭. With every new idea, it seemed like the impossible always stood before us.

However, a simple and unassuming suggestion emerged and proved to be perfect: "What if we automate this somehow?" Most social media platforms provide APIs and integration methods for post publishing, but creative work and the team's time were still required.

AI as a Facilitator!

By witnessing the rapid evolution of AI on a daily basis, it became evident how it can streamline the resolution of our problems. In this tutorial, I will demonstrate how we implemented the automatic and efficient generation of tweets on our profile.

It's important to emphasize that despite automating tweet generation, we still actively monitor and respond to all comments. So, if you come across posts on our Twitter profile, rest assured that we are there! 😄😄😄

Step 1 - Twitter Developer Platform

The first step was to activate our account on the developer portal and create a project in the free tier, which allows us to generate approximately 1500 tweets per month. Then, we selected the read and write option under App permissions, and proceeded to create an application to generate the authentication keys: Consumer Keys/API Key and Secret, and Authentication Tokens/Access Token and Secret.

Step 2 - OpenAI API

The second step involves generating the access key for your OpenAI account. When you create an account, you will receive a $5 credit for testing API requests. Later on, you will need to acquire a plan to access the public APIs.

Once you have the access key, it's time to prepare the request for v1/chat/completions.

Step 3 - Preparing the Model

Before we proceed with the API requests, we can prepare our model directly in the browser at chat.openai.com.
Use this template and insert the information about your game. Provide details and make adjustments multiple times until you achieve a satisfactory result.

Step 4 - Postman + OpenAPI

Import the curl template into Postman, and replace the values with:

- API KEY: Replace this value with the API key you generated in Step
- ENCODED TEMPLATE: Format your refined prompt text from Step 3 using an online Escape/Unescape tool. Replace this value with the formatted text.
- YOUR MODEL: List all the generated models from the browser in Step 3 that met your needs. Include them here without any limitations. This will help refine and make the response more aligned with your request.
- YOUR REQUEST: Simply provide your request here, specifying the type of tweet you need. For example: "I need a tweet," "I need a tweet in French," or "I need a tweet in English."

Step 5 - Postman + Twitter

Import the request api.twitter.com/2/tweets from the collection.

Replace the values generated in Step 1 in the Authorization tab:

- Consumer Key: Key generated in the Consumer Keys/API Key and Secret group
- Consumer Secret: *Key generated in the Consumer Keys/API Key and Secret group
*- Access Token: Key generated in the Authentication Tokens/Access Token and Secret group
- Access Token Secret: Key generated in the Authentication Tokens/Access Token and Secret group

Next, fill in the request body with the world's most famous test string: "Hello World" and click on "Send".

When the magic happens, your profile will be fully integrated with the APIs.

Step 6 - Azure AppLogic

Access your account through the Azure Portal and create a new Logic App.

After deploying the application, click on the "Design" option. This is where we will start configuring the recurrence of tweets.

Select 'Blank App Logic / Scheduler / Recurrence'. On the next screen, define the desired time interval. For this example, since we are using free/trial tiers, it is recommended to set the execution between 6 and 12 hours.

Now, create a new step of type 'HTTP' and copy the values used in Postman, as shown in Step 4. At this point, it is important to remember to add the access authorization, as demonstrated in the images below. (If you encounter difficulties with this task, you can use the file located here to configure it).

The next task is of type 'Data Operations/Parse JSON'. Here, we need to define the structure of the API response. Select the option 'Use sample payload to generate schema' and past your response body to automatically map the structure.

With the response structure ready, let's manipulate the data. Create a task of type 'Control/For each', selecting the 'choices' node (where the fields we need are located). Then, create a task of type 'Control/Condition' and validate whether the 'message' field is filled or not.

If the field is not filled, no action is required. However, you can customize this task: redo the steps, send an email, or send a predefined tweet. The choice of what to do in this flow depends on your desire/need. In my case, I simply end the execution.

If the 'message' field is correctly filled, the last step is to send the request to the Twitter API. Create a new task of type 'HTTP' and fill in the same values used in Step 5 (configuration of the task here, if necessary). Don't forget to fill in the authentication values.

Step 7 - Testing

To test your application, simply select the 'Run Trigger' option and monitor the execution log to check the status. In case of successful execution, just access your Twitter profile to see the update.

Remember that, according to the time configured in step 6, you will have a new post!

Important:

You may need to continue refining your model by including new information and adjusting the values of temperature, top_p, frequency_penalty, presence_penalty, and max_tokens. To understand these parameters, you can refer to the OpenAPI documentation, test them in Postman, and then update your HTTP task in step 6.

Step 8 - Final Considerations

In this article, I aimed to provide detailed steps so that non-developers or individuals without familiarity with cloud environments or programming languages can easily configure the tasks!

If you want to learn more about the game "The Agent - A Role Playing Game" and its development, you can find more details here, here, or here.

To stay updated with our tweets, you can follow our page here.

Furthermore, if you have any questions during the process, feel free to reach out. I'm available to assist and clarify any doubts that may arise.

I hope this detailed guide proves useful in keeping the independent gaming community engaged and up-to-date with the latest developments. 🎮

Together, we can drive the growth and success of this passionate community! 😍 ❤️

Best regards!

Gerando engajamento para jogos indies com OpenApi + Twitter API + Azure LogicApps (PT/BR)

Eduardo Queiróz — Fri, 26 May 2023 16:33:32 +0000

Briefing

Em resumo, desenvolver jogos não é minha atividade principal. É um hobby que pratico principalmente durante o meu tempo livre na DZ9 Games, nas madrugadas de insônia ou nos fins de semana. No entanto, percebi que essa jornada tornava-se impossível de trilhar sozinho, então decidi convidar um ilustrador e um roteirista para se juntarem à equipe de #theagent, os quais prontamente aceitaram o desafio.

Se você quiser saber mais detalhes sobre o jogo e sua evolução, pode encontrá-los aqui, aqui ou aqui.

O Problema

À medida que a versão Demo (que está em andamento) se aproxima, estamos começando a trabalhar nas redes sociais e explorar possíveis canais de divulgação. No entanto, enfrentamos um desafio, uma vez que ninguém na equipe se dedica integralmente a essa ocupação. O tempo necessário para esse trabalho de "divulgação", "propaganda" e "engajamento" entra em conflito direto com os ajustes das mecânicas do jogo, o trabalho artístico e aprimoramentos na continuidade.

Mais uma vez, é impossível conciliar e realizar todas essas tarefas com o mínimo de qualidade.

A solução estava próxima

Durante a fase de desenvolvimento, nos deparamos com a necessidade de resolver nossos problemas de divulgação. Consideramos várias opções, como contratar uma agência, um especialista em mídias sociais ou até mesmo um estagiário, mas essas alternativas acarretavam principalmente custos adicionais 😭. A cada nova ideia, parecia que o impossível sempre se apresentava diante de nós.

No entanto, surgiu uma sugestão simples e despretensiosa que se revelou perfeita: "E se automatizarmos isso de alguma maneira?" A maioria das redes sociais fornece API's e meios de integração para a publicação de posts, mas ainda assim o trabalho criativo e o tempo da equipe eram necessários.

IA como facilitadora!

Ao acompanhar a rápida evolução das IA's diariamente, ficou evidente como elas podem facilitar a resolução dos nossos problemas. Neste tutorial, vou mostrar como implementamos a geração automática e eficiente dos tweets em nosso perfil.

É importante ressaltar que, apesar da automatização na geração dos tweets, continuamos a acompanhar e responder todos os comentários. Portanto, se você se deparar com posts em nosso perfil no Twitter, pode ter certeza de que estamos lá! 😄😄😄

Passo 1 - Twitter Developer Platform

O primeiro passo foi ativar a nossa conta no portal do desenvolvedor e criar um projeto na camada gratuita, o que nos permite gerar aproximadamente 1500 tweets por mês. Em seguida, marcamos a opção de escrita e leitura em App permissions e logo após criamos uma aplicação para gerar as chaves de autenticação dos grupos: Consumer Keys/API Key and Secret, e Authentication Tokens/Access Token and Secret.

Passo 2 - Open AI API

O segundo passo consiste em gerar a chave de acesso para a sua conta na OpenAI. Ao criar a conta, você receberá um crédito de $5 para realizar testes nas requisições. Posteriormente, será necessário adquirir um plano para ter acesso às APIs públicas.

Com a chave de acesso em mãos, é hora de preparar a requisição para v1/chat/completions.

Passo 3 - Preparando o modelo

Antes de iniciarmos a requisição através das API's podemos preparar nosso modelo diretamente no browser em chat.openai.com.
Utilize esse template, em seguida insira as informações do seu jogo, informe detalhes e ajuste diversas vezes até conseguir um resultado satisfatório.

Passo 4 - Postman + OpenAPI

Importe a curl template no Postman, e substitua os valores de:

- API KEY: Chave gerada no passo 2.
- TEMPLATE COM ENCODED: Formate o seu texto de prompt que foi refinado no passo 3 em uma ferramenta online de Escape/Unescape.
- EXEMPLO GERADO NO BROWSER: Informe todos os modelos gerados no browser no passo 3 e que atenderam suas necessidades aqui, sem limites, isso vai ajudar que sua resposta seja refinada e cada vez mais aderente a sua solicitação.
- SUA SOLICITAÇÃO: Aqui não têm segredo! (exemplo: preciso de um tweet, preciso de um tweet em francês, preciso de um tweet em inglês).

Passo 5 - Postman + Twitter

Importe da collection a requisição api.twitter.com/2/tweets

Substitua os valores gerados no passo 1 na aba Authorization:

- Consumer Key: Chave gerada no grupo Consumer Keys/API Key and Secret
- Consumer Secret: Chave gerada no grupo Consumer Keys/API Key and Secret
- Access Token: Chave gerada no grupo Authentication Tokens/Access Token and Secret
- Access Token: Chave gerada no grupo Authentication Tokens/Access Token and Secret

Em seguida, preencha o request body com a string de testes mais famosa do mundo: Hello Word e clique em Send.

Quando a mágica acontecer, o seu perfil estará totalmente integrado as API's.

Passo 6 - Azure AppLogic

Acesse sua conta por meio do Portal Azure e crie um novo aplicativo lógico.

Após implantar o aplicativo, clique na opção de design. Aqui é onde iniciaremos a configuração da recorrência dos tweets.

Selecione 'Blank App Logic / Scheduler / Recurrence'. Na próxima tela, defina o intervalo de tempo desejado. Para este exemplo, como estamos usando camadas gratuitas/trial, recomenda-se configurar a execução entre 6 e 12 horas.

Agora, crie um novo passo do tipo _HTTP _e copie os valores utilizados no Postman, conforme mostrado no passo 4. Neste momento, é importante lembrar de adicionar a autorização de acesso, conforme demonstrado nas imagens abaixo. (Caso tenha dificuldades nesta tarefa, você pode utilizar o arquivo localizado aqui para configurá-la).

A próxima tarefa é do tipo 'Data Operations/Parse Json'. Aqui, precisamos definir a estrutura da resposta da API. Selecione a opção 'Use sample payload to generate schema' para que a estrutura seja mapeada automaticamente.

Com a estrutura de resposta pronta, vamos manipular os dados. Crie uma tarefa do tipo 'Control/For each', selecionando o nó 'choices' (aqui estão os campos que precisamos). Em seguida, crie uma tarefa do tipo _'Control/Condition' e valide se o campo 'message' está preenchido ou não.

Caso o campo não esteja preenchido, não é necessário fazer nada. No entanto, você pode ajustar essa tarefa: refazer os passos, enviar um e-mail ou enviar um tweet pré-definido. A escolha do que fazer nesse fluxo depende do seu desejo/necessidade. No meu caso, simplesmente encerro a execução.

Se o campo 'message' estiver preenchido corretamente, o último passo é enviar a requisição para a API do Twitter. Crie uma nova tarefa do tipo _HTTP _e preencha os mesmos valores utilizados no passo 5 (configuração da tarefa aqui, caso necessário). Não se esqueça de preencher os valores de autenticação.

Passo 7 - Testes

Para testar sua aplicação, basta selecionar a opção _'Run Trigger' _e acompanhar o log de execuções para verificar o status. Em caso de sucesso na execução, basta acessar seu perfil no Twitter para ver a atualização.

Lembre-se de que, de acordo com o tempo configurado no passo 6, você terá uma nova postagem!

Importante:

Talvez seja necessário continuar refinando seu modelo, incluindo novas informações e ajustando os valores de temperatura, top_p, frequency_penalty, presence_penalty e max_tokens. Para entender esses parâmetros, basta acessar a documentação da OpenAPI, testá-los no Postman e, em seguida, atualizar sua tarefa de HTTP no passo 6.

Passo 8 - Considerações finais

Neste artigo, procurei detalhar os passos para que pessoas não desenvolvedoras ou sem familiaridade com ambientes em nuvem ou linguagens de programação também possam configurar as tarefas com facilidade!

Se você quiser saber mais detalhes sobre o jogo The Agent - A Role Playing Game e sua evolução, pode encontrá-los aqui, aqui ou aqui.

E para acompanhar nossos tweets, pode seguir nossa página aqui.

Além disso, caso surjam dúvidas durante o processo, fique à vontade para entrar em contato. Estou disponível para ajudar e esclarecer qualquer questão que possa surgir.

Espero que este guia detalhado seja útil para manter a comunidade de jogos independentes engajada e atualizada com as novidades. 🎮

Juntos, podemos impulsionar o crescimento e o sucesso dessa comunidade apaixonada! 😍 ❤️

Abraços!