summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabio Alessandrelli <fabio.alessandrelli@gmail.com>2021-07-08 19:48:33 +0200
committerFabio Alessandrelli <fabio.alessandrelli@gmail.com>2021-07-08 23:04:16 +0200
commit189c3532643cc20baec8d873d2d19f31d9e69075 (patch)
tree546c347add9ff7519a1af612a1ec66952307e2fc
parente44c42fde859ccf828f0e1beaec6a6229e991f9a (diff)
downloadfork-godot-webrtc-native-189c3532643cc20baec8d873d2d19f31d9e69075.tar.gz
fork-godot-webrtc-native-189c3532643cc20baec8d873d2d19f31d9e69075.tar.bz2
fork-godot-webrtc-native-189c3532643cc20baec8d873d2d19f31d9e69075.zip
[CI] Use organization's repository for automated builds.
Update README.md to reflect new build sources.
-rw-r--r--.github/actions/webrtc-download/action.yml11
-rw-r--r--README.md17
2 files changed, 15 insertions, 13 deletions
diff --git a/.github/actions/webrtc-download/action.yml b/.github/actions/webrtc-download/action.yml
index 0aa52c3..75e268d 100644
--- a/.github/actions/webrtc-download/action.yml
+++ b/.github/actions/webrtc-download/action.yml
@@ -4,7 +4,7 @@ inputs:
repo:
description: 'Base repository'
required: true
- default: "Faless/webrtc-builds"
+ default: "godotengine/webrtc-actions"
release:
description: 'Release tag'
required: true
@@ -31,13 +31,10 @@ runs:
RTC_BASE_URL: https://github.com/${{ inputs.repo }}/releases/download/${{ inputs.release }}/${{ inputs.webrtc-base-name }}
run: |
cd ${{ inputs.out-dir }}
- format=tar.gz
- extract="tar -xzf"
+
libplat=${{ inputs.platform }}
if [ "${{ inputs.platform }}" = "windows" ]; then
libplat=win
- format=7z
- extract="7z x -y"
elif [ "${{ inputs.platform }}" = "osx" ]; then
libplat=mac
fi
@@ -45,8 +42,8 @@ runs:
for arch in ${{ inputs.archs }}
do
echo "Downloading ${{ env.RTC_BASE_URL }}-${{ inputs.platform }}-${arch}.tar.gz"
- curl -L ${{ env.RTC_BASE_URL }}-${libplat}-${arch}.${format} -o ${arch}.${format}
- ${extract} ${arch}.${format}
+ curl -L ${{ env.RTC_BASE_URL }}-${libplat}-${arch}.tar.gz -o ${arch}.tar.gz
+ tar -xzf ${arch}.tar.gz
done
mv lib ${{ inputs.platform }}
diff --git a/README.md b/README.md
index 5f6e8ab..556417b 100644
--- a/README.md
+++ b/README.md
@@ -7,15 +7,15 @@
### Compiling
-Clone this repository with the following command to checkout both [godot-cpp](https://github.com/GodotNativeTools/godot-cpp) and [godot_headers](https://github.com/GodotNativeTools/godot_headers) dependencies.
+Clone this repository with the following command to checkout both [godot-cpp](https://github.com/godotengine/godot-cpp) and [godot-headers](https://github.com/godotengine/godot-headers) dependencies.
```
-$ git clone --recurse-submodules git@github.com:godotengine/webrtc-native.git
+$ git clone --recurse-submodules https://github.com/godotengine/webrtc-native.git
```
Note that if you wish to use a specific branch, add the -b option to the clone command:
```
-$ git clone --recurse-submodules -b 3.2 git@github.com:godotengine/webrtc-native.git
+$ git clone --recurse-submodules -b 3.2 https://github.com/godotengine/webrtc-native.git
```
If you already checked out the branch use the following commands to update the dependencies:
@@ -29,7 +29,7 @@ Right now our directory structure should look like this:
webrtc-native/
├─bin/
├─godot-cpp/
-| └─godot_headers/
+| └─godot-headers/
├─src/
└─webrtc/
```
@@ -54,7 +54,12 @@ $ cd ..
### Building WebRTC
-Use [this script](https://github.com/Faless/webrtc-builds) to build and package the WebRTCLibrary (`branch-heads/68`), or [**download latest pre-compiled binaries**](https://github.com/Faless/webrtc-builds/releases)
+Building WebRTC is quite a complex task, involves huge downloads and long build times, and produces multiple output libraries that needs to bundled together.
+
+To make things easier, a set of [GitHub Actions](https://docs.github.com/en/actions) are used to generate the library for this plugin, [available in this repository](https://github.com/godotengine/webrtc-actions).
+
+Alternatively, [**download the latest pre-compiled libraries**](https://github.com/godotengine/webrtc-actions/releases).
+
Extract content of `include` into `webrtc/include` and content of `bin` into `webrtc/<your platform>`
### Compiling the plugin.
@@ -63,4 +68,4 @@ Extract content of `include` into `webrtc/include` and content of `bin` into `we
$ scons platform=<your platform> target=<your target>
```
-The generated library and associated `gdns` will be placed in `bin/webrtc/` or `bin/webrtc_debug/` according to the desired target. You simply need to copy that folder into your project.
+The generated library and associated `tres` will be placed in `bin/webrtc/` or `bin/webrtc_debug/` according to the desired target. You simply need to copy that folder to the root folder of your project.