NEKERAFA / pokedexica-twitch

A Pokédex quiz game for Numerica Twich Jam

A Pokédex quiz game for Numerica Twich Jam

Table of contents

• About
• Build
• Contributing
• License

About

🇪🇸 Español

Si parece que tu chat sabe contar, prepárate para un nuevo nivel de dificultad: ¿sabe tu chat el nombre de todos los Pokémons?

🎮 Mecánicas principales

Pokédexica es un minijuego para tu canal de Twitch, basado en Numerica de RothioTome. El objetivo es claro: consigue que tus espectadores completen la Pokédex Nacional (puedes encontrar más información en https://www.pokemon.com/pokedex) siguiendo las siguientes restricciones:

• Cada espectador puede escribir el nombre de un Pokémon.
• Si un espectador escribe el nombre de un Pokémon que no es el siguiente en la Pokédex, la Pokédex se reiniciará.
• Un espectador no puede escribir el nombre de dos Pokémons consecutivos.

📌 Mecánicas a implementar

• Evitar que el juego se congele al ver los ajustes.
• Añadir ajustes de usabilidad: repetir usuario, eliminar animaciones, etc...
• Elegir la pokedex a jugar.
• Bannea temporalmente a los espectadores que se equivoquen.
• Pokédex con los Pokémons obtenidos por los espectadores:
  • Seleccionar pokedex a ver
  • Espectador que lo descubrió primero.
  • Veces descubierto.
• Ranking con los espectadores que más completaron la Pokédex.
• Veces que se completó la Pokédex.
• Añadir vamohacalmarno como squirtle.

🖥️ Obtén el juego

Pokédexica está disponible gratuitamente en itch.io en las siguientes plataformas:

• GNU/Linux x86 64 bits
• Windows 64 bits
• macOS*

*Nota: la versión de macOS no está testeada aún. Puedes ver más información en Running Godot apps on macOS (ENG) de la documentación de Godot.

---

🇬🇧 English

If your chat seems to be able to count, get ready for the next level of difficulty: Does your chat know the names of all the Pokémon?

🎮 Mainly features

Pokédexica is a mini-game for your Twitch channel, based on Numerica by RothioTome. The aim is pretty clear: Get your viewers to complete the National Pokédex (you can find more information in https://www.pokemon.com/pokedex) following the next restrictions:

• Any viewer can send the name of a Pokémon.
• If a viewer sends the name of a Pokémon that is not the next in the Pokédex, the Pokédex will be restarted.
• A viewer can't send two consecutive Pókemons.

📌 Next features

• Timeout to each viewer who are wrong.
• Pokédex list with the Pokémons obtained by your viewers:
  • Viewer who found the Pokémon first.
  • Number of times the Pokémon was found.
• Ranking of the viewers who contributed most to the Pokédex.
• Number of times the pokedex was completed.

🖥️ Get the game

Pokédexica is avaliable freely in itch.io to the following platforms:

• GNU/Linux x86 64 bits
• Windows 64 bits
• macOS*

*Note: macOS version is not tested yet. You can show more info in Running Godot apps on macOS section in Godot documentation.

Build

You must download Godot Engine 4.1.1 to be able to export the game to your platform.

First of all, dowload the game source code using zip download in GitHub or cloning this repository using git cli command:

git clone https://github.com/NEKERAFA/pokedexica-twitch.git

Then, you must add your Twitch App client ID and client secret in order to Pokédexica can connect to Twitch API. The client ID is setted in autoloads/globals.gd (don't worry to expose that, client ID is public):

12   const TWITCH_CLIENT_ID: String = "<your Client ID>"

Instead, client secret is private and this cannot be distributed, so you need to create a new script in autoloads folder with the name secrets.gd before open the proyect in Godot Engine. You must to put the next code:

 1   const TWITCH_CLIENT_SECRET = "<your Client secret>"

You can know about obtaing a Twitch client ID and client secret in 'Registering Your App' section in Twitch Developers documentation.

Export

Currently, Pokedéxica is exported to Windows, GNU/Linux and macOS. You can export to your system in Godot Engine > Proyect > Export... . In this window you can add a new export system on Add... button.

Then you can export to this system clicking in Export Project... button and saving export file in a property folder (you can use dist folder).

You can know more about export configuration in Export section in Godot documentation.

Troubleshooting

• start: Can't autoload: res://autoloads/secrets.gd.

  You must create the secrets.gd file in autoloads folder with your client secret.

• Parser Error: Identifier "Secrets" not declared in the current scope.

  You need to add secrets.gd file into autoloads section. For that, you need to go to Godot Engine > Proyect > Proyect Settings... > Autoloads, and import secrets.gd script.

  

Contributing

To get started contributing, make sure to read the Contributing Guide before making a issue or a pull request. Also you can check the Code of Conduct Guides.

License

GNU General Public License Version 3, 29 June 2007

Copyright (c) 2023 Rafael Alcalde Azpiazu (NEKERAFA)

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

See all legal notice in LICENSE file