Skip to content

Commit

Permalink
Change readme and folder structure.
Browse files Browse the repository at this point in the history
  • Loading branch information
stechyo committed Jan 12, 2024
1 parent e9d15f7 commit 92ba3e8
Show file tree
Hide file tree
Showing 32 changed files with 48 additions and 64 deletions.
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ install-steam-audio:

release:
scons platform=linux target=template_debug && scons platform=windows target=template_debug
cp -r ./project ./godot-steam-audio
rm -rI ./godot-steam-audio/.godot ./godot-steam-audio/.gitignore ./godot-steam-audio/.gitattributes ./godot-steam-audio/bin/libphonon.so
mkdir godot-steam-audio
cp -r ./project ./godot-steam-audio/demo
rm -rI ./godot-steam-audio/demo/.godot ./godot-steam-audio/demo/.gitignore ./godot-steam-audio/demo/.gitattributes ./godot-steam-audio/demo/addons/godot-steam-audio/bin/libphonon.so
cp -r ./godot-steam-audio/demo/addons ./godot-steam-audio/addons
zip -r ./godot-steam-audio-vX.Y.Z.zip godot-steam-audio README.md
rm -rI ./godot-steam-audio
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# godot-steam-audio
This is a GDExtension that integrates the [steam-audio](https://valvesoftware.github.io/steam-audio/) library into Godot 4.2.
This is a GDExtension that integrates the [steam-audio](https://valvesoftware.github.io/steam-audio/) library
into Godot 4.2. This adds sound effects such as occlusion and reverb into the engine.

### [Demo Video](https://www.youtube.com/watch?v=vRnzfnb93Gw)
![A picture of the editor screen with some godot-steam-audio nodes.](doc/imgs/editor.png)
Expand All @@ -22,10 +23,10 @@ are currently working. Mac probably works, but I don't have the time nor the mon
- Download the [latest release](https://github.com/stechyo/godot/releases/tag/steam-audio) or clone and build [my fork of Godot](https://github.com/stechyo/godot/tree/4.2-gdext/audio-stream-funcs).
- Download the [latest release](https://github.com/stechyo/godot-steam-audio/releases/latest) of the extension or build it yourself.
- Download the [latest supported release](https://github.com/ValveSoftware/steam-audio/releases/tag/v4.5.0) of steam-audio, and copy the binaries
that you find in the `lib` folder for your operating system to the `bin/` folder of your project, which
that you find in the `lib` folder for your operating system to the `addons/godot-steam-audio/bin/` folder of your project, which
should contain a `libgodot-steam-audio` library (.dll or .so) and a .gdextension file. Note that, since your OS is likely 64-bit, you'll want the x64 version (e.g. `windows-x64`).

Your project should have a `bin/` folder with:
Your project should have an `addons/godot-steam-audio/bin/` folder with:
- `libgodot-steam-audio.gdextension`
- `libgodot-steam-audio.linux.template_debug.x86_64` for Linux, or a similar .dll for Windows
- `libphonon.so` for Linux, or `phonon.dll`, `phonon.lib` and some other files for Windows - these are the
Expand Down
2 changes: 1 addition & 1 deletion SConstruct
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ elif env["platform"] == "windows":


library = env.SharedLibrary(
"project/bin/godot-steam-audio{}{}".format(env["suffix"], env["SHLIBSUFFIX"]),
"project/addons/godot-steam-audio/bin/godot-steam-audio{}{}".format(env["suffix"], env["SHLIBSUFFIX"]),
source=sources,
)

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[configuration]

entry_symbol = "init_extension"
compatibility_minimum = 4.2

[libraries]

linux.x86_64.debug ="res://addons/godot-steam-audio/bin/libgodot-steam-audio.linux.template_debug.x86_64.so"
linux.x86_64.release = "res://addons/godot-steam-audio/bin/libgodot-steam-audio.linux.template_release.x86_64.so"
linux.debug.arm64 = "res://addons/godot-steam-audio/bin/libgodot-steam-audio.linux.template_debug.arm64.so"
linux.release.arm64 = "res://addons/godot-steam-audio/bin/libgodot-steam-audio.linux.template_release.arm64.so"
windows.x86_64.debug = "res://addons/godot-steam-audio/bin/libgodot-steam-audio.windows.template_debug.x86_64.dll"
windows.x86_64.release = "res://addons/godot-steam-audio/bin/libgodot-steam-audio.windows.template_release.x86_64.dll"
macos.debug = "res://addons/godot-steam-audio/bin/libgodot-steam-audio.macos.template_debug.framework"
macos.release = "res://addons/godot-steam-audio/bin/libgodot-steam-audio.macos.template_release.framework"

[icons]

SteamAudioPlayer = "res://addons/godot-steam-audio/icons/steam_audio_player.svg"
SteamAudioListener = "res://addons/godot-steam-audio/icons/steam_audio_listener.svg"
SteamAudioConfig = "res://addons/godot-steam-audio/icons/steam_audio_config.svg"
SteamAudioGeometry = "res://addons/godot-steam-audio/icons/steam_audio_geometry.svg"
Binary file not shown.
Binary file not shown.
Binary file added project/addons/godot-steam-audio/bin/libphonon.so
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://csacya4jxkknl"
path="res://.godot/imported/steam_audio_config.svg-0d8717c30b9c45cf3ef033d13603954f.ctex"
path="res://.godot/imported/steam_audio_config.svg-c39e3c278ccb02a7385dfd8ee32eba0f.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/steamaudio/icons/steam_audio_config.svg"
dest_files=["res://.godot/imported/steam_audio_config.svg-0d8717c30b9c45cf3ef033d13603954f.ctex"]
source_file="res://addons/godot-steam-audio/icons/steam_audio_config.svg"
dest_files=["res://.godot/imported/steam_audio_config.svg-c39e3c278ccb02a7385dfd8ee32eba0f.ctex"]

[params]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://dv5ap5spg12x2"
path="res://.godot/imported/steam_audio_geometry.svg-de64e4f733d5b3b90b79c9211a0fee5c.ctex"
path="res://.godot/imported/steam_audio_geometry.svg-94d5a72b9710b48d2c973dbf6258de3d.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/steamaudio/icons/steam_audio_geometry.svg"
dest_files=["res://.godot/imported/steam_audio_geometry.svg-de64e4f733d5b3b90b79c9211a0fee5c.ctex"]
source_file="res://addons/godot-steam-audio/icons/steam_audio_geometry.svg"
dest_files=["res://.godot/imported/steam_audio_geometry.svg-94d5a72b9710b48d2c973dbf6258de3d.ctex"]

[params]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://b1xs3k1lbekcq"
path="res://.godot/imported/steam_audio_listener.svg-2cc3a2b41ab495425bbfd4d03636196d.ctex"
path="res://.godot/imported/steam_audio_listener.svg-3c2b796a9296ff66889083f90ca46d02.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/steamaudio/icons/steam_audio_listener.svg"
dest_files=["res://.godot/imported/steam_audio_listener.svg-2cc3a2b41ab495425bbfd4d03636196d.ctex"]
source_file="res://addons/godot-steam-audio/icons/steam_audio_listener.svg"
dest_files=["res://.godot/imported/steam_audio_listener.svg-3c2b796a9296ff66889083f90ca46d02.ctex"]

[params]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://b2n2sbpyufp36"
path="res://.godot/imported/steam_audio_player.svg-14906bd5a4e3338b1ce8113ef44a3f73.ctex"
path="res://.godot/imported/steam_audio_player.svg-1e7b97ef042863ef810c9575eafab08d.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/steamaudio/icons/steam_audio_player.svg"
dest_files=["res://.godot/imported/steam_audio_player.svg-14906bd5a4e3338b1ce8113ef44a3f73.ctex"]
source_file="res://addons/godot-steam-audio/icons/steam_audio_player.svg"
dest_files=["res://.godot/imported/steam_audio_player.svg-1e7b97ef042863ef810c9575eafab08d.ctex"]

[params]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
importer="texture"
type="CompressedTexture2D"
uid="uid://dmu8epd0rc1wu"
path="res://.godot/imported/steam_audio_stream.svg-f068aaf23d589c4102d4b2cc306e8a08.ctex"
path="res://.godot/imported/steam_audio_stream.svg-7782f4d258b821087a4f303dd0c2c2d7.ctex"
metadata={
"vram_texture": false
}

[deps]

source_file="res://addons/steamaudio/icons/steam_audio_stream.svg"
dest_files=["res://.godot/imported/steam_audio_stream.svg-f068aaf23d589c4102d4b2cc306e8a08.ctex"]
source_file="res://addons/godot-steam-audio/icons/steam_audio_stream.svg"
dest_files=["res://.godot/imported/steam_audio_stream.svg-7782f4d258b821087a4f303dd0c2c2d7.ctex"]

[params]

Expand Down
22 changes: 0 additions & 22 deletions project/bin/libgodot-steam-audio.gdextension

This file was deleted.

4 changes: 2 additions & 2 deletions project/scenes/demo.tscn
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[gd_scene load_steps=36 format=3 uid="uid://bilxmr83dwsgw"]

[ext_resource type="Script" path="res://src/player.gd" id="1_c2adp"]
[ext_resource type="SteamAudioMaterial" uid="uid://dbai50r63k346" path="res://addons/steamaudio/materials/rock_material.tres" id="1_wtcfy"]
[ext_resource type="SteamAudioMaterial" uid="uid://dbai50r63k346" path="res://addons/godot-steam-audio/materials/rock_material.tres" id="1_wtcfy"]
[ext_resource type="AudioStream" uid="uid://badsntcuvwx3t" path="res://sound/2.mp3" id="3_0iivb"]
[ext_resource type="PackedScene" uid="uid://6sgtpvtg5aic" path="res://scenes/wooden_house.tscn" id="3_tysju"]
[ext_resource type="AudioStream" uid="uid://ca6667b63t1vv" path="res://sound/pluck1.mp3" id="5_00edw"]
[ext_resource type="AudioStream" uid="uid://4axfbe53b587" path="res://sound/pluck2.mp3" id="6_dw5dv"]
[ext_resource type="SteamAudioMaterial" uid="uid://cexuij8fef5ay" path="res://addons/steamaudio/materials/carpet_material.tres" id="6_ph4pe"]
[ext_resource type="SteamAudioMaterial" uid="uid://cexuij8fef5ay" path="res://addons/godot-steam-audio/materials/carpet_material.tres" id="6_ph4pe"]
[ext_resource type="Script" path="res://src/random_pluck.gd" id="7_gx8pe"]

[sub_resource type="PhysicalSkyMaterial" id="PhysicalSkyMaterial_nkwlr"]
Expand Down
Binary file removed project/sound/1.mp3
Binary file not shown.
19 changes: 0 additions & 19 deletions project/sound/1.mp3.import

This file was deleted.

0 comments on commit 92ba3e8

Please sign in to comment.