https://github.com/kiwijuice56/sand-slide
Fast falling sand game made within Godot and utilizing GDExtension features
https://github.com/kiwijuice56/sand-slide
cellular-automata cpp falling-sand game gamedev gdextension gdscript godot godot-engine godot4 indiedev sandbox-game simulation
Last synced: 2 months ago
JSON representation
Fast falling sand game made within Godot and utilizing GDExtension features
- Host: GitHub
- URL: https://github.com/kiwijuice56/sand-slide
- Owner: kiwijuice56
- License: mit
- Created: 2022-10-26T03:51:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T13:39:19.000Z (4 months ago)
- Last Synced: 2025-03-30T14:09:46.900Z (3 months ago)
- Topics: cellular-automata, cpp, falling-sand, game, gamedev, gdextension, gdscript, godot, godot-engine, godot4, indiedev, sandbox-game, simulation
- Language: C++
- Homepage: https://kiwijuice56.itch.io/sand-slide
- Size: 93.4 MB
- Stars: 98
- Watchers: 2
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# sand-slide
A falling sand game made with Godot 4's GDextension feature. The full game can be downloaded for free on [itch.io](https://kiwijuice56.itch.io/sand-slide) or on the [Google Play Store](https://play.google.com/store/apps/details?id=org.godotengine.sandslide).
## Project Structure
The simulation logic is implemented in C++ as a GDextension (in `extension`) that gets compiled into a binary file (in `game\bin`).
The user interface was created in a Godot 4.3 project (in `game`).
## Compiling for Windows
If coding on Windows, no dependencies or installations are required to build the `.dll` binaries.
```
cd sand-slide
scons
```
## Compiling For Other Platforms
Compilation for other platforms is essentially the same as on Windows, but it will sometimes require you to install other dependencies.
The [official Godot documentation] on building for target platforms has all of the necessary information to compile `sand-slide` on other platforms.
## Creating New Elements
Each element is a class within `extension\elements` that inherits the `Element` class.
To create your own element, create a new `.h` file and define a class with the name of your element.
Your element must inherit the `Element` class and implement the virtual methods `process(*SandSimulation sim, int row, inc col)`, `get_explode_resistance()`, and `get_acid_resistance()`.
`process(*SandSimulation sim, int row, inc col)` contains the main logic for your element.
As the simulation iterates through each cell, it will call `process` on the respective `Element` class and pass the `row` and `col` that the cell was encountered in.
Elements have no data or information associated with them, so `process` is essentially a static method that must infer
state from surrounding cells. You can get information and manipulate the simulation by calling methods from the `SandSimulation` pointer. Here is an example for sand:
```cpp
const double FLAME = 1 / 64.0;
void process(SandSimulation *sim, int row, int col) override {
// randf is a helper method defined within sand_simulation.h that returns a random real number [0, 1)
if (sim->randf() < FLAME && sim->is_on_fire(row, col)) {
// Set this cell to glass when on fire
sim->set_cell(row, col, 25); // 25 is the ID of glass, as explained further below
return;
}
// Otherwise, keep falling
sim->move_and_swap(row, col, row + 1, col);
}
```
More helper methods can be found in `extension\sand_simulation.h`.
`get_explode_resistance()` and `get_acid_resistance()` must return a float [0, 1] in which 0 is no resistance to explosions/acid and 1 is maximum resistance to explosions/acid. `get_temperature()` must return an integer, -1 being cold, 0 being neutral, and 1 being hot. `get_toxicity()` must return an integer as well, 1 being toxic and 0 being neutral.
When you are ready to add your element to the game, import the header file in `extension\elements\all_elements.h` and add it to the `elements` vector within the `fill_elements` method.
The index that you add the element to will become its `ID`. Other elements reference this `ID` when checking conditions, such as above where sand is replaced with glass. Glass is placed at the 25th spot of the `elements` vector, so the `ID` of glass is 25.
In the Godot project, create a new `ElementButton` within the `ElementSelector` scene (`main\ui\element_selector\ElementSelector`) and set `ID` to the same one as defined above. The visuals of your element can be modified by creating a resource that extends the `ElementVisual` class and placing it within `game\main\element_visuals\`.
## Save Files
The game allows you to manage save files. Files are stored in `user:\\`, or `%APPDATA%\Godot\app_userdata\sandslide` on Windows. Each folder corresponds to a save file and contains a Godot resource and an image. The luminosity value of each pixel in the texture represents its ID, allowing you to edit the file in an external program and load it back into the game.
The game also saves custom elements as Godot resources (`*.tres`) in the same folder as save files.
## Attribution
[Plumbing](https://icons8.com/icon/67287/plumbing), [eraser](https://icons8.com/icon/78855/eraser),
[file](https://icons8.com/icon/77782/file), [support](https://icons8.com/icon/60006/support), [help](https://icons8.com/icon/59807/help) and
[exit](https://icons8.com/icon/71200/close) icons by [Icons8](https://icons8.com/).
GDExtension Starter Project by [paddy-exe](https://github.com/paddy-exe/GDExtensionSummator)