Skip to content

Commit b99e7eb

Browse files
committed
Update CONTRIBUTING.md
1 parent cca7e39 commit b99e7eb

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

.github/CONTRIBUTING.md

+18-14
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,29 @@ You can contribute in different ways:
1111
For the last one, you will need to download the Godot editor and obtain assets.
1212
Read below to find out how to obtain assets.
1313

14-
## Assets
14+
## Editing the game in the Godot editor
1515

16-
Follow this link to the assets folder: [link](https://drive.google.com/drive/folders/1U4wTjBu2qo1cInH3IAowsFC5yq56V5uQ?usp=sharing)
16+
First, obtain necessary files:
1717

18-
Open this link and then follow these steps:
18+
1. Download Godot editor *version 4.3* from the [Godot website](https://godotengine.org).
19+
2. Clone the game repository using Git.
20+
3. Download assets folder from this [Google Drive folder](https://drive.google.com/drive/folders/1U4wTjBu2qo1cInH3IAowsFC5yq56V5uQ?usp=sharing).
21+
4. Copy and paste downloaded assets into 'assets' folder in the game repository.
22+
5. You will see a popup asking whether you want to replace some files - press "Yes".
1923

20-
1. Download the whole folder.
21-
2. Copy the contents of the downloaded folder.
22-
3. Paste into 'assets' folder in the game repo.
23-
4. You should see a popup asking whether you want to replace the files - press "Yes".
24-
5. Open the Godot editor and make sure that all of the assets were loaded correctly.
24+
Then, follow these steps to correctly import assets into Godot editor:
2525

26-
Note that public version of assets contains censored versions of item icons, tower icons and tower sprites. Such assets will look like they are a solid "blue" color.
26+
1. Open the game project in the Godot editor.
27+
2. Wait for Godot editor to import assets. Open the "Output" window to confirm that the process is finished. There will be some errors - that's expected.
28+
3. Press Ctrl-S to save changes.
29+
4. Close Godot editor
30+
5. Open a terminal with Git and run this command: $ git status. You should see that some files were modified (by Godot editor).
31+
6. Run this command: $ git restore
32+
7. Open the game project in the Godot editor again.
33+
8. Wait for Godot editor to import assets. This time, there should be no errors.
34+
9. Run this command again: $ git status. There should be no local changes if steps were followed correctly.
2735

28-
## Running the game in editor
29-
30-
After you've obtained the Godot editor and assets you can start the editor and try to run the game.
31-
32-
Note that the topic of how to use Godot editor is out of scope of this document. Godot documentation and tutorials are available online.
36+
Note: Public version of assets contains censored versions of item icons, tower icons and tower sprites. Such assets will look like they are a solid "blue" color.
3337

3438
## Copyright / Contributor License Agreement
3539
Any code you submit will become part of the repository and be distributed under the YouTD2 license. By submitting code to the project you agree that the code is your work and you can give it to the project.

assets/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
This folder contains assets.
22

3-
Note that only the .import files are checked into git. The actual .png, .mp3 files are stored in a google drive and need to be downloaded separately.
3+
Note that only the .import files are checked into git. The actual .png, .mp3 files are stored in a google drive and need to be downloaded separately. See CONTRIBUTING.md for instructions.

0 commit comments

Comments
 (0)