Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sunflower-land/sunflower-land
https://github.com/sunflower-land/sunflower-land
Last synced: about 3 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/sunflower-land/sunflower-land
- Owner: sunflower-land
- Created: 2021-05-07T22:29:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-11T03:41:50.000Z (1 day ago)
- Last Synced: 2024-12-11T04:27:14.078Z (1 day ago)
- Language: TypeScript
- Size: 170 MB
- Stars: 1,544
- Watchers: 60
- Forks: 603
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- best-of-crypto - GitHub - 6% open · ⏱️ 05.06.2024): (Others)
- stars - sunflower-land/sunflower-land - (TypeScript)
README
Sunflower Land
The goal of this project is to create a decentralized and community-driven MetaVerse style game.
This repo includes the front-end game in which users can play and interact with the game on the Polygon Network and offchain data.
Looking to help out? Read our [contributing docs](https://github.com/sunflower-land/sunflower-land/blob/main/docs/CODE_CONTRIBUTING.md)
By contributing you agree to our [terms and services](https://docs.sunflower-land.com/support/terms-of-service)
# Website | Official Links
### 🌻 Main Website
[https://sunflower-land.com/](https://sunflower-land.com/)
### 🧑🌾 Start Farming | Play
[https://sunflower-land.com/play](https://sunflower-land.com/play)
### 😕 Stuck somewhere ?
Read the official docs/ litepaper here: [docs.sunflower-land.com](https://docs.sunflower-land.com/)
### 👶 How to play ?
Follow the official guide here: [How to Play?](https://docs.sunflower-land.com/getting-started/how-to-play)
### ❓ Need Help ?
First Read the FAQ's here: [FAQ's](https://sunflowerland.freshdesk.com/support/solutions/101000195014)
Still not satisfied? Submit a support ticket here: [Submit a ticket](https://sunflowerland.freshdesk.com/support/tickets/new)
### ‼️ Have a suggestion/proposal/cool idea ?
Please add a new idea for the community to vote on, here: [SFL Idea Portal](https://sunflower-land.ideas.aha.io/)
# 🎨 Sunnyside Assets
Sunflower Land uses crops, icons and tiles from Daniel Diggle's SunnySide Asset Pack.
These raw assets/tiles are not in this repo. You must purchase the asset pack if you wish to extend these assets or use them elsewhere.
[Download Here](https://danieldiggle.itch.io/sunnyside)
# 👶 Getting Started
You can take a look at the instructions in [CODE_CONTRIBUTING.md](https://github.com/sunflower-land/sunflower-land/blob/main/docs/CODE_CONTRIBUTING.md) to get started on open-source contribution for Sunflower Land
# 🧪 Testing
`yarn test`
This runs a range of business logic unit tests in the repo.
The plan is to use react testing library to test some of the core user interactions as well.
# ⚙️ Architecture
We use `xstate` to control the manage the user and session using a State Machine approach. This prevents our application from getting into invalid states and handles the use cases of switching accounts, networks, etc.
The primary states include:
- Connecting (connecting to MetaMask)
- Ready (Waiting for user input - Start)
- Signing (Sign a message to verify the account on the API)
- Authorising (Checking if a user has an account/farm)
- Unauthorised (when one of the above state transitions fails)
- Authorised (Play the game!)
# ⚙️ Vite
The app uses vite for bundling and development purposes. You can set build specific configuration in `vite.config.ts`
# 🌈 Tailwind
Tailwind is our CSS tool of choice. It enables us to:
- Use utility based classes
- Consistent theming (view `tailwind.config.js`)
- Perform CSS processing to minimize build sizes
# 🏷️ ERC1155 Metadata
Metadata is generated from markdown files.
Prerequisites:
`yarn global add ts-node`
To add new item:
1. Create `{SFT id}.md` file in `metadata\markdown` folder
2. Add `{SFT id}.png(gif)` file to `public\erc1155\images` folder
3. Run `yarn metadata`
# 🗃️ Directory Organization
- Assets: Images, Music, Branding and other Media
- Components: Reusable react components
- Lib: Utils, classes, machines and more.
- Features: Core domain concepts that have their own use cases/boundaries.
Each feature (e.g. crops) has a similar nested structure of components, graphql & lib that are specific only to that feature.
# 🤝 Contributing Guidelines
👨💻 Developers - https://github.com/sunflower-land/sunflower-land/blob/main/docs/CODE_CONTRIBUTING.md
🧑🎨 Artists - https://github.com/sunflower-land/sunflower-land/blob/main/docs/ART_CONTRIBUTING.md
# ⚖️ No Licence
The previous version was used unethically on other Blockchains. The team is working on deciding the licence that will best suit our community. Until then, the code falls under No Licence and cannot be reused.
All media assets (images and music) are not available for use in commercial or private projects.
To access the crops, resources and land tiles, please refer to the [SunnySide Asset Pack](https://danieldiggle.itch.io/sunnyside)
If you wish to use Bumpkin NFTs or custom Sunflower Land collectibles in your own project please reach out to the core team on [Discord](https://discord.com/invite/sunflowerland).