<p align="center">
  <a href="https://www.neos.moe">
     <img src="https://avatars.githubusercontent.com/u/110732697?s=400&u=d33638f1e89dfb41395a47004fe211fcf219444d&v=4" 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 [WASM](https://webassembly.org/).

## ✨ Features

- 🎮 [Play online](https://neos.moecube.com) with the [ygopro](https://ygopro.org/) client or neos itself
- 🌍Play with LAN connection
- 🤖️Duel with AI

## 📦Quick Start
1. Open the [neos page](https://neos.moecube.com) and input the player name(e.g., "ccc") and password(use "AI" if you want to duel with computer), then click `ENTER ROOM` button
2. After entering in the waiting room, there're two ways to choose your deck:
  - Using the recommended deck by clicking the drop-down menu
  - Uploading your favorite deck with `YDK` file
3. With the deck being chosen, click the `Ready` and `Start` button and enjoy the duel!

<center class="half">
  <img alt="" src="./screenshots/quick_start-login.jpeg" width="250" />
  <img alt="" src="./screenshots/quick_start-room.jpeg" width="350" />
</center>

## 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

## Updates
Update every weekend if the author is free.

## 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.
