Skip to content

Commit 35b0d82

Browse files
nethical6nethical6
committed
add new readme
1 parent 737c1db commit 35b0d82

2 files changed

Lines changed: 141 additions & 1 deletion

File tree

‎.github/ISSUE_TEMPLATE/tree_submission.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: "Tree Submission"
3+
about: "Submit a new tree variant for the project"
4+
title: "[Tree] <Your Tree Name Here>"
5+
labels: [tree-submission]
6+
assignees: ''
7+
---
8+
9+
**Tree Name:**
10+
<Your tree's name here>
11+
12+
**Description:**
13+
<What makes your tree special or unique?>
14+
15+
**Author:**
16+
<Your name or nickname>
17+
18+
**Donation Link:**
19+
<Your donation link, or write "N/A">
20+
21+
**Unlock Price:**
22+
<e.g., 100 coins>
23+
24+
**Growth Animation Video Link(s):**
25+
<Paste the link to your tree's growth animation video variant 1>
26+
<Paste the link to your tree's growth animation video variant 2>
27+
28+
**Notes/Variants:**
29+
<Optional: Add any notes, or mention if you have multiple variants.>

‎README.md‎

Lines changed: 112 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,112 @@
1-
# trease-artwork
1+
2+
# 🌳 How to Submit a New Tree Variant (Absolute Beginner Guide)
3+
4+
Welcome! You can contribute a new tree variant to this project **without writing any code**. This guide is for absolute beginners—even if you’ve never used GitHub before!
5+
6+
---
7+
8+
## 1. Create a GitHub Account (If You Don’t Have One)
9+
10+
1. Go to [https://github.com/](https://github.com/)
11+
2. Click **Sign up** (top right corner).
12+
3. Enter your email, create a password, and follow the steps to finish registration.
13+
4. Confirm your email address by clicking the link sent to your inbox.
14+
15+
---
16+
17+
## 2. How to Submit Your Tree
18+
19+
1. **Log in to GitHub** and go to this repository (the page you’re on now).
20+
2. Click the **Issues** tab at the top.
21+
3. Click the green **New Issue** button.
22+
4. Select the **Tree Submission** template.
23+
5. Fill in the form with your tree’s details (see below for what each field means).
24+
6. Click **Submit new issue** at the bottom. That’s it!
25+
26+
---
27+
28+
## 3. What You Need to Prepare
29+
30+
When submitting a new tree, you’ll be asked for:
31+
32+
- **Tree Name**: The name of your tree variant (e.g., "Cherry Blossom").
33+
- **Description**: What makes your tree special or unique.
34+
- **Author**: Your name or nickname.
35+
- **Donation Link**: (Optional) A link where people can support you, or write "N/A".
36+
- **Unlock Price**: The price to unlock this tree (e.g., 100 coins).
37+
- **Growth Animation Video Link(s)**: Link(s) to video(s) showing your tree’s growth animation. You can add as many variants as you like—just paste each link on a new line.
38+
39+
---
40+
41+
## 4. Tree Drawing Guidelines
42+
43+
- **Canvas Size**: Your tree should always fit within a 480×480 pixel square.
44+
- **No Grass Grid Needed**: You do **not** need to draw an isometric grass grid. Just draw the tree itself.
45+
- **Simple is Best**: Focus on the tree. No need for extra backgrounds or decorations.
46+
47+
For inspiration and examples, check the [`lit_tree`](lit_tree/) folder in this repository.
48+
49+
---
50+
51+
**Need help?** If you’re unsure about any step, just open an issue with your question or check the [`lit_tree`](lit_tree/) folder to get a few art samples.
52+
53+
Thank you for helping our digital forest grow! 🌱
54+
55+
Welcome! You can contribute a new tree variant to this project without writing any code. All you need to do is open a new GitHub issue with the required information. Follow this step-by-step guide:
56+
57+
## 1. What You Need to Prepare
58+
59+
When submitting a new tree, please provide the following details:
60+
61+
- **Tree Name**: The name of your tree variant (e.g., "Cherry Blossom", "Pixel Pine").
62+
- **Description**: A short description of your tree (what makes it special, its inspiration, etc.).
63+
- **Donation Link**: (Optional) A link where people can donate to support your work or a related cause.
64+
- **Unlock Price**: The price required to unlock this tree.
65+
- **Growth Animation Video Link**: A link to a video (YouTube, Vimeo, Google Drive, etc.) showing your tree's growth animation.
66+
67+
You can submit as many tree variants as you like! Link to growth videos of all variants of a particular tree should be in the same issue
68+
69+
## 2. Tree Drawing Guidelines
70+
71+
- **Canvas Size**: Your tree should always fit within a 480×480 pixel square. This keeps all trees consistent.
72+
- **Background**: Use pitch black (#000000) as background
73+
- **No Grass Grid Needed**: You do **not** need to draw an isometric grass grid. Just draw the tree itself.
74+
- **Simple is Best**: Focus on the tree.
75+
76+
For inspiration and examples, check the [`lit_tree`](lit_tree/) folder in this repository.
77+
78+
## 3. How to Submit Your Tree (Step-by-Step)
79+
80+
1. **Go to the Issues tab** of this GitHub repository.
81+
2. Click **"New Issue"**.
82+
3. Use the following template to fill in your tree details:
83+
84+
```
85+
**Tree Name:**
86+
[Your tree's name here]
87+
88+
**Description:**
89+
[A short description of your tree]
90+
91+
**Author:**
92+
[Your name]
93+
94+
**Donation Link:**
95+
[Your donation link, or write "N/A"]
96+
97+
**Unlock Price:**
98+
[e.g., 100 coins,]
99+
100+
**Growth Animation Video Link:**
101+
[Paste the link to your tree's growth animation video variant 1]
102+
[Paste the link to your tree's growth animation video variant 2]...
103+
104+
```
105+
106+
4. **Submit the issue**. That's it! We'll review your submission and get in touch if we need more info.
107+
108+
---
109+
110+
**Need help?** If you're unsure about any step, just open an issue with your question or check the [`lit_tree`](lit_tree/) folder to get a few art samples.
111+
112+
Thank you for helping our digital forest grow! 🌱

0 commit comments

Comments
 (0)