<p align="center">
  <a href="https://neos.moecube.com">
     <img src="./neos-assets/neos-logo.svg" height="128">
    <h1 align="center">Neos</h1>
  </a>
</p>


<p align="center">
  <a aria-label="Language" href="https://www.typescriptlang.org/">
    <img alt="" src="https://img.shields.io/github/languages/top/DarkNeos/neos-ts?style=for-the-badge">
  </a>
  <a aria-label="React" href="https://reactjs.org/">
    <img alt="" src="https://img.shields.io/badge/react.js-%5E18.2.0-yellow?style=for-the-badge&logo=react">
  </a>
  <a aria-label="License" href="https://github.com/DarkNeos/neos-ts/blob/main/LICENSE">
    <img alt="" src="https://img.shields.io/github/license/DarkNeos/neos-ts?color=&style=for-the-badge">
  </a>
</p>

English | [简体中文](./README-zh_CN.md)

Neos is web version of [Yu-Gi-Oh!](https://www.yugioh-card.com/en/) game written in [TypeScript](https://www.typescriptlang.org/), [React.js](https://reactjs.org/) and [WebAssembly](https://webassembly.org/).

## ✨ Features

- **[WIP]Competitive Match**
  - Match online with players from around the world, and your ranking will be displayed in real-time on the leaderboard.
- **[WIP]Entertainment Match**
  - Battle with any deck, set aside victory or defeat for now, and fully enjoy the pleasure of the duel.
- **Single Mode**
  - Engage in duels with AI, validate your deck, or simply pass the time.
- **Custom Room**
  - Create a custom duel room to easily battle with friends, or even host a competitive tournament.
- **Replay**
  - Freely review past duels and savor those thrilling moments of reversal.
- **Deck Editing**
  - Create and edit decks, choose from tens of thousands of cards, and assemble a unique build.

## 📦Quick Start
See the [player guide](https://doc.neos.moe/docs/category/%E7%8E%A9%E5%AE%B6%E6%8C%87%E5%8D%97) for details.

## Screenshot
<p align="center">
  <img alt="" src="./screenshots/duel.png" width="512">
</p>

## Document
See the [Document for Neos](https://doc.neos.moe).

## Deployed
* https://neos.moecube.com by Mycard community
* https://www.neos.moe by [Cloudflare](https://www.cloudflare.com/)

## 🤝Contributing
Create merge requests in [gitlab repo](https://code.mycard.moe/mycard/Neos).

## 🔗Community
Neos is developed in [mycard](https://mycard.moe/) community, join the [QQ Chat](https://github.com/DarkNeos/ygopro-doc/blob/main/assets/ygo_qq.png), where you can ask questions and make discussions.

## Why we develop Neos?
- [Document](./docs/release-2023_02_19_CN.md) by the author
- [Post](https://ygobbs.com/t/ygopro%E7%BD%91%E9%A1%B5%E7%89%88%E5%BC%80%E5%8F%91%E8%BF%9B%E5%B1%95/403397) in [ygobbs](https://ygobbs.com/) forum

## Authors
- Chunchi Che ([@SKTT1Ryze](https://github.com/SKTT1Ryze))
- timelic [@timelic](https://github.com/timelic)

## Lincese
                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
