Commit 315ddc52 authored by Chunchi Che's avatar Chunchi Che

Merge branch 'feat/readme' into 'main'

Feat/readme

See merge request mycard/Neos!108
parents 947901b7 ba4dfec0
Pipeline #20281 passed with stages
in 4 minutes and 26 seconds
# Neos
Web version of ygopro written in [React](https://reactjs.org/) + [Babylon.js](https://www.babylonjs.com/).
<p align="center">
<a href="http://neos.moe">
<picture>
<img src="https://avatars.githubusercontent.com/u/110732697?s=400&u=d33638f1e89dfb41395a47004fe211fcf219444d&v=4" height="128">
</picture>
<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="Babylon.js" href="https://github.com/BabylonJS/Babylon.js">
<img alt="" src="https://img.shields.io/badge/babylon.js-%5E5.29.0-red?style=for-the-badge&logo=github">
</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>
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 [Babylon.js](https://www.babylonjs.com/). It supports the following features:
- [Play online](http://neos.moe) with the [ygopro](https://ygopro.org/) client or Neos itself
- Play with LAN connection
- [WIP] Duel with AI
## Screenshot
<p align="center">
<img alt="" src="./screenshots/duel.png" width="512">
</p>
## 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](https://github.com/DarkNeos/ygopro-doc/blob/main/doc/progress/2022-07-01_2022-10-07.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))
## 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.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment