From 1b2168ca312696c68c72f95349bc1a2707522596 Mon Sep 17 00:00:00 2001 From: Atralupus Date: Wed, 2 Oct 2024 23:14:58 +0900 Subject: [PATCH] Rewrite readme --- README.ko.md | 22 ++++++++++++++++++++++ README.md | 32 ++++++++++++++++++++------------ backend/app/CONTRIBUTING.md | 1 + client/CONTRIBUTING.md | 1 + 4 files changed, 44 insertions(+), 12 deletions(-) create mode 100644 README.ko.md create mode 100644 backend/app/CONTRIBUTING.md create mode 100644 client/CONTRIBUTING.md diff --git a/README.ko.md b/README.ko.md new file mode 100644 index 00000000..8045a251 --- /dev/null +++ b/README.ko.md @@ -0,0 +1,22 @@ +# Savor22b + +## 게임 소개 +광활한 세계를 탐험하며 자신만의 농장에서 직접 재배한 식재료로 음식을 만들고 모험을 떠나는 게임입니다. +거주하는 지역에 따라 자라는 식재료가 다르니, 때로는 돼지고기 씨앗을 심어 돼지고기를 수확해보세요. + +정성껏 만든 음식에는 생명석을 사용해 생명을 불어넣을 수 있으며, 슈퍼푸드들과 생활하며 여러 던전을 탐험하고 점령해보세요! + +저희 게임에 대해서 더 알아보고 싶다면 [기획 문서](https://github.com/not-blond-beard/Savor22b/wiki/%EA%B8%B0%ED%9A%8D)를 참고해주세요. + +### 프로토 타입 +아직 한참 프로토 타입을 만들고 기획 변경해보고 프로토 타입 만들고 변경하고를 반복하고 있습니다. +기획이 어느정도 안정화가 되면 MVP를 만들 예정이니 기대해주세요. + +## 블록체인 +Savor22b는 탈중앙을 지향하는 게임입니다. [libplanet](https://github.com/planetarium/libplanet)을 사용해 게임의 모든 정보는 블록체인에 기록되며 누구든 게임 제작에 참가할 수 있고 포크할 수 있습니다. +게임 내 모든 정보는 체인으로써 모두 투명하게 공개되고 조작이 불가능합니다. + +## 기여 +저희 프로젝트는 전부 오픈 소스로 개발될 예정이며 아직은 게임 이름도 제대로 없는 프로토 타입이지만 기여는 항상 환영합니다. +레포는 모노레포로 게임 정보를 체인에 저장하고 GQL로 정보를 제공하는 backend와 데이터를 받아 게임을 실행하는 client가 있습니다. +각 프로젝트마다 README.md와 CONTRIBUTING.md 문서가 있으니 참고해주세요. diff --git a/README.md b/README.md index 35cd2b52..f35ef0b9 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ # Savor22b -## Intro -- 5:5 턴제 전투 게임 레포지터리입니다. -- 슈퍼 푸드를 만들기 위해 랜덤한 확률의 종자를 수확하고, -- 음식을 조합하고, 발전시켜 최고의 슈퍼 푸드를 키워가는 것이 목표! -- 슈퍼 푸드를 열심히 키워 던전을 돌고, 유저들과의 전투에서 승리하는 것이 목표입니다. - -## Description -- 본 프로젝트는 모노레포로 구성되어 있습니다. -- Backend + Frontend 레포지터리로 구성되어 있습니다. -- 각 레포지터리 아래 상세한 README가 존재합니다. -- ~프로젝트는 [노션](https://atralupus.notion.site/90ef4532315c434d9305405046117981)을 통해 티켓을 관리하고 있습니다.~ - - 현재는 기존 티켓들의 이관 없이, 추가되는 티켓들부터는 [Github project](https://github.com/orgs/not-blond-beard/projects/4/views/3)를 사용해 관리하고 있습니다. + +## Game Overview +Embark on an epic journey through a vast world, creating delicious meals using ingredients grown on your very own farm. Depending on the region you live in, different crops and ingredients will grow. For example, you can plant a pork seed and harvest fresh pork! + +By using Life Stones, you can bring your carefully crafted dishes to life. Team up with your superfood companions to explore and conquer various dungeons! + +To learn more about our game, check out the [design document](https://github.com/not-blond-beard/Savor22b/wiki/%EA%B8%B0%ED%9A%8D). + +### Prototype +We're still in the early stages, constantly iterating and refining the prototype. Once the design is more stable, we plan to develop an MVP. Stay tuned! + +## Blockchain +Savor22b is a game built with decentralization in mind. All game data is recorded on the blockchain using [libplanet](https://github.com/planetarium/libplanet), ensuring that anyone can contribute to the development or fork the game. All information within the game is transparently stored on-chain, making it impossible to tamper with. + +## Contributions +Although we're still in the prototype phase and haven’t even settled on a final name, all contributions are welcome! Our project will be fully open source. + +The repository is structured as a monorepo, with a backend that stores game data on the blockchain and provides it via GQL, and a client that consumes the data and runs the game. + +Each project includes a README.md and CONTRIBUTING.md for more details, so be sure to check them out! diff --git a/backend/app/CONTRIBUTING.md b/backend/app/CONTRIBUTING.md new file mode 100644 index 00000000..a17f78d5 --- /dev/null +++ b/backend/app/CONTRIBUTING.md @@ -0,0 +1 @@ +please wait... diff --git a/client/CONTRIBUTING.md b/client/CONTRIBUTING.md new file mode 100644 index 00000000..a17f78d5 --- /dev/null +++ b/client/CONTRIBUTING.md @@ -0,0 +1 @@ +please wait...