Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change documentation to reflect 4.3 changes #161

Merged
merged 1 commit into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/tutorials/getting_started/scene-tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/resources.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gaea's resources

Gaea takes advantage of Godot's **resources**. In this addon, they're used for the generators' settings, telling the generators which tiles from the TileMap to use, and for the modifiers.
Gaea takes advantage of Godot's **resources**. In this addon, they're used for the generators' settings, to hold data for each cell in the grid, and for the modifiers.

## GaeaGrid

Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/chunk_generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ In this quick tutorial, you'll learn how to enable chunk generation to make it s
>
> If you don't have an understanding of these topics, see [this lovely tutorial](https://www.youtube.com/watch?v=oB1xsCcO9wI) by [DevWorm](https://www.youtube.com/@dev-worm)!

Gaea comes pre-packaged with multiple different generators, but for this example, we'll be using the `NoiseGenerator` node, the `TilemapGaeaRenderer` node, the Godot built-in `TileMap` node, and a `CharacterBody2D` node, which will represent our Player!
Gaea comes pre-packaged with multiple different generators, but for this example, we'll be using the `NoiseGenerator` node, the `TilemapGaeaRenderer` node, the Godot built-in `TileMapLayer`s (or `TileMap`, if you prefer that), and a `CharacterBody2D` node, which will represent our Player!

> Only certain generators work with chunk loading. These are the `ChunkAwareGenerator`s, such as the noise or heightmap generators. `ChunkAwareGenerator` is an abstract class that you can extend to make your own generators, but shouldn't be used on its own.

![Nodes needed for the Tutorial](../assets/tutorials/chunk_generation/chunk-generation-nodes.png)
![Nodes needed for the Tutorial](../assets/tutorials/chunk_generation/chunk-generation-loader.png)

### Setup

Expand All @@ -26,7 +26,7 @@ Once you have all the pre-requisite nodes mentioned above setup in your scene, y

After finding this node, you can add it anywhere in the scene tree, in this instance, I've added it as a child node of the `NoiseGenerator`

![Add the Chunk](..%2Fassets%2Ftutorials%2Fchunk_generation%2Fchunk-generation-loader.png)
![Add the Chunk](../assets/tutorials/chunk_generation/chunk-generation-nodes.png)

Once this node has been added to the tree, you need to assign the `Generator` and `Actor` nodes to the `ChunkLoader2D`, these map to the `NoiseGenerator` and `CharacterBody2D` nodes mentioned earlier!

Expand Down
6 changes: 5 additions & 1 deletion docs/tutorials/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this tutorial, you'll learn how to make basic generation of a dungeon akin to

Gaea comes with a bunch of different **generator nodes**. To make a dungeon, we'll use the [WalkerGenerator](/generators/walker.md), inspired by the algorithm used in Nuclear Throne.

> You can use the scene at `res://scenes/tutorials/getting_started/getting_started.tscn` to follow this tutorial. It starts with WalkerGenerator, TilemapGaeaRenderer and TileMap nodes:
> You can use the scene at `res://scenes/tutorials/getting_started/getting_started.tscn` to follow this tutorial. It starts with WalkerGenerator, TilemapGaeaRenderer and TileMapLayer nodes:
>
> ![Scene tree](../assets/tutorials/getting_started/scene-tree.png)

Expand All @@ -22,6 +22,10 @@ To see the generation, you'll have to render it with a `GaeaRenderer` node. In t

![Referencing nodes](../assets/tutorials/getting_started/referencing_nodes.gif)

> In Godot 4.3, you'll probably want to use `TileMapLayer`s instead. This is also the default in Gaea from that version.
![Assinging TileMapLayer nodes](../assets/tutorials/getting_started/tilemap-layers.gif)


### GeneratorSettings

First, let's set up the generator's settings. Go to the generator's inspector, and add a `WalkerGeneratorSettings` resource to its `settings` property.
Expand Down
31 changes: 20 additions & 11 deletions scenes/demos/noise/chunk_noise_demo.tscn

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions scenes/tutorials/getting_started/getting_started.tscn
Original file line number Diff line number Diff line change
Expand Up @@ -702,9 +702,11 @@ sources/3 = SubResource("TileSetAtlasSource_x2mok")
[node name="WalkerGenerator" type="Node2D" parent="."]
script = ExtResource("1_s6jhf")

[node name="TileMap" type="TileMap" parent="."]
[node name="TileMap" type="Node2D" parent="."]

[node name="Layer0" type="TileMapLayer" parent="TileMap"]
use_parent_material = true
tile_set = SubResource("TileSet_vnxuo")
format = 2

[node name="TilemapGaeaRenderer" type="Node" parent="."]
script = ExtResource("4_1xbqd")