Browse Source

chore: organize plugin files and documentation

Bryan Lee 1 year ago
parent
commit
1f0d7c43cd

+ 1 - 5
.gitignore

@@ -1,13 +1,9 @@
 # VSCode
 # VSCode
 .vscode/
 .vscode/
 
 
-# External plugin source files
-./godot-ios-plugins/
-./godot-play-games-services/
-
 # Secrets
 # Secrets
 secrets/*
 secrets/*
 !secrets/.gitkeep
 !secrets/.gitkeep
 
 
 # Build logs
 # Build logs
-build.log
+build.log

+ 8 - 2
README.md

@@ -8,9 +8,15 @@ Set up the Godot project as usual. Some export platforms require extra configura
 
 
 ## iOS and Game Center
 ## iOS and Game Center
 
 
-We manage a custom fork of the official [`godot-ios-plugins`](https://github.com/bryanmylee/godot-ios-plugins) repo, built for Godot 4.2.
+We manage a custom fork of the official [`godot-ios-plugins`](https://github.com/bryanmylee/godot-ios-plugins) repo in [`plugins/godot-ios-plugins`](./plugins/godot-ios-plugins/), built for Godot 4.2.
 
 
-Plugins should be exported from [`godot-ios-plugins/`](./godot-ios-plugins/) and stored in `project/ios/`. Refer to the [iOS plugins document](./project/ios/README.md) for build instructions.
+Refer to the [iOS build document](./project/ios/README.md).
+
+## Android and Google Play Games Services
+
+We manage a custom fork of [`Iakobs`](https://github.com/Iakobs/godot-play-game-services)/[`godot-play-games-services`](https://github.com/bryanmylee/godot-play-games-services) to reduce global namespace conflicts in [`plugins/godot-play-games-services`](./plugins/godot-play-games-services/).
+
+Refer to the [Android build document](./project/android/README.md).
 
 
 # Deployment
 # Deployment
 
 

+ 0 - 0
godot-ios-plugins → plugins/godot-ios-plugins


+ 0 - 0
godot-play-games-services → plugins/godot-play-games-services


+ 1 - 1
project/android/README.md

@@ -20,7 +20,7 @@ sudo ln -sfn /opt/homebrew/opt/openjdk@17/libexec/openjdk.jdk /Library/Java/Java
 
 
 ## Configuring Google Play Games Services
 ## Configuring Google Play Games Services
 
 
-We rely on a custom form of the [`godot-play-games-services`](https://github.com/bryanmylee/godot-play-games-services) Android plugin for Google Play Games integration, with tweaks to the source code to better integrate with our codebase.
+We rely on a custom fork of the [`godot-play-games-services`](https://github.com/bryanmylee/godot-play-games-services) Android plugin for Google Play Games integration, with tweaks to the source code to better integrate with our codebase.
 
 
 To enable the plugin, [set up Google Play Games Services](https://developers.google.com/games/services/console/enabling). The rough steps to follow on the guide are:
 To enable the plugin, [set up Google Play Games Services](https://developers.google.com/games/services/console/enabling). The rough steps to follow on the guide are:
 
 

+ 0 - 4
project/authentication/README.md

@@ -14,8 +14,6 @@ The service provides more than just authentication, and is managed by [`steam_se
 
 
 iOS users are authenticated with Apple Game Center by default.
 iOS users are authenticated with Apple Game Center by default.
 
 
-We manage a custom fork of the official [`godot-ios-plugins`](https://github.com/bryanmylee/godot-ios-plugins) repo, built for Godot 4.2.
-
 [`apple_game_center_service.gd`](../services/apple_game_center_service.gd) provides typed Promise-based wrappers around the Game Center plugin.
 [`apple_game_center_service.gd`](../services/apple_game_center_service.gd) provides typed Promise-based wrappers around the Game Center plugin.
 
 
 > In addition to setting up Game Center in Godot, Game Center has to be [configured in App Store Connect](https://developer.apple.com/documentation/gamekit/enabling_and_configuring_game_center/). Refer to the [Game Center plugin document](../ios/plugins/gamecenter/README.md) for details about setting up Game Center.
 > In addition to setting up Game Center in Godot, Game Center has to be [configured in App Store Connect](https://developer.apple.com/documentation/gamekit/enabling_and_configuring_game_center/). Refer to the [Game Center plugin document](../ios/plugins/gamecenter/README.md) for details about setting up Game Center.
@@ -26,8 +24,6 @@ Refer to the [iOS build document](../ios/README.md).
 
 
 Android users are authenticated with Google Play Games Services by default.
 Android users are authenticated with Google Play Games Services by default.
 
 
-We manage a custom fork of [`Iakobs`](https://github.com/Iakobs/godot-play-game-services)/[`godot-play-games-services`](https://github.com/bryanmylee/godot-play-games-services) to reduce global namespace conflicts.
-
 > In addition to setting up Play Games Services in Godot, Play Games Services has to be configured on the [Google Play Console](https://play.google.com/console/u/0/developers).
 > In addition to setting up Play Games Services in Godot, Play Games Services has to be configured on the [Google Play Console](https://play.google.com/console/u/0/developers).
 
 
 Refer to the [Android build document](../android/README.md).
 Refer to the [Android build document](../android/README.md).

+ 13 - 6
project/ios/README.md

@@ -12,22 +12,29 @@ Open `<project_name>/Supporting Files/<project_name>-Info`, and add a new string
 
 
 ## Building plugins for Godot 4.0
 ## Building plugins for Godot 4.0
 
 
-In the root directory, recursively clone the `godot-ios-plugins` repository and set the `godot` submodule to a commit matching the current engine.
+We've recursively cloned `godot-ios-plugins` into this directory and set the `godot` submodule to the commit matching our current engine version.
 
 
 ```bash
 ```bash
-git clone --recursive https://github.com/godotengine/godot-ios-plugins.git
-cd godot-ios-plugins/godot
+git clone --recursive https://github.com/godotengine/godot-ios-plugins.git plugins/godot-ios-plugins
+cd plugins/godot-ios-plugins/godot
 git fetch
 git fetch
 git checkout <godot_engine_commit>
 git checkout <godot_engine_commit>
+```
+
+To build the plugin, run the commands below:
+
+```bash
 scons platform=ios target=template_debug
 scons platform=ios target=template_debug
-cd ..
+cd .. # plugins/godot-ios-plugins
 scons target=release_debug arch=arm64 simulator=no plugin=<plugin> version=4.0
 scons target=release_debug arch=arm64 simulator=no plugin=<plugin> version=4.0
 ./scripts/generate_static_library.sh <plugin> release_debug 4.0
 ./scripts/generate_static_library.sh <plugin> release_debug 4.0
 ./scripts/generate_xcframework.sh <plugin> release_debug 4.0
 ./scripts/generate_xcframework.sh <plugin> release_debug 4.0
 ```
 ```
 
 
-Then, rename `./bin/<plugin>.release_debug.xcframework` to `./bin/<plugin>.xcframework` and move the directory to `./plugins/<plugin>/`.
+## Adding plugins to the project
+
+Then, rename `./bin/<plugin>.release_debug.xcframework` to `./bin/<plugin>.xcframework` and move the directory to the project's iOS plugin directory [`project/ios/plugins/`](../ios/plugins/).
 
 
 ```bash
 ```bash
-mv ./bin/<plugin>.release_debug.xcframework ./plugins/<plugin>/<plugin>.xcframework
+mv ./bin/<plugin>.release_debug.xcframework ../../project/ios/plugins/<plugin>/<plugin>.xcframework
 ```
 ```