ZkNoid

ZkNoid is a home for ZK games platform on Mina protocol.

⛔️ THIS REPOSITORY IS DEPRECATED ⛔️. Please consider the migration to the repository with the updated architecture.

The new store hacking guide: https://zknoid.medium.com/zknoid-hackers-guide-v2-try-yourself-the-updated-store-benefits-c736ca1c76e8

Old description

🚀 Founded on hackathon in Istanbul with the idea to unify gaming ecosystem in Mina, this project has won the grand prize in Mina Navigators and conducted a testnet event!

ZkNoid is a gaming store for provable games. Modular framework is provided for developers bringing all the infrastructure they need to easily deploy games on Mina Protocol. After Zk Proofs integration to the game process, game is listed on the store becoming a part of the project ecosystem

Learn more about ZkNoid on zknoid.io

• Games Store
• Docs
• Blog

Get started

If you want to create your own provable game, please check out the hacker's guide

Repository

Repository contains ZkNoid game platform monorepo. Monorepo

Deployments

• Develop branch in deployed to https://dev.zknoid.io/
• Main branch in deployed to https://app.zknoid.io/

Setup

Project can be used localy. Here are the commands for set-up

git clone https://github.com/ZkNoid/zknoid
cd zknoid
 
# ensures you have the right node js version
# !important! Without this step the app may not work!
# If nvm is not installed please install it. 
# `nvm install` may be needed to install correct node version
nvm use

pnpm install

pnpm env:inmemory dev

Implementing your own game

ZkNoid is a modular platform that makes it easy to implement you own game using platform infrastructure. To build a game you need to create a game folder inside apps/web/games. Define game config and implement front-end and contracts part in packages/chain/src/

• Read more in hacker's guide
• Learn more about SDK here
• Learn more about your game implementation here

Listing game on ZkNoid store

Instructions, terms and conditions to list your game on ZkNoid SDK: Integration guide

Interesting places

• Arkanoid game verification – arkanoid/GameContexts.ts
• Competitions and leaderboard system engine/GameHub.ts
• Matchmaking system – engine/MatchMaker.ts
• Randzu logic implementation – randzu/RandzuLogic.ts
• Games frontend implementation apps/web/games
• Games contracts implementation packages/chain/src/