Browse Source

doc: ios project setup

Bryan Lee 1 year ago
parent
commit
d00d7eaccf
2 changed files with 15 additions and 11 deletions
  1. 15 0
      README.md
  2. 0 11
      project/ios/plugins/gamecenter/README.md

+ 15 - 0
README.md

@@ -2,6 +2,16 @@
 
 
 A minimal Godot project with cross-platform authentication, matchmaking, and server-authoritative multiplayer.
 A minimal Godot project with cross-platform authentication, matchmaking, and server-authoritative multiplayer.
 
 
+# Environment Setup
+
+Set up the Godot project as usual. Some export platforms require extra configuration.
+
+## 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.
+
+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.
+
 # Network Architecture
 # Network Architecture
 
 
 ## Central Server
 ## Central Server
@@ -59,6 +69,11 @@ The game has exports for Windows, macOS, Linux, iOS, Android, and the Web.
   - [x] OAuth 2.0 / OpenID for Web
   - [x] OAuth 2.0 / OpenID for Web
 - [ ] ~~Scalable Server-Authoritative Multiplayer~~
 - [ ] ~~Scalable Server-Authoritative Multiplayer~~
 - [ ] Server-side Authentication
 - [ ] Server-side Authentication
+  - [x] Authentication Server
+  - [ ] Steam for Desktop
+  - [ ] Apple Game Center for iOS
+  - [ ] Google Play Games for Android
+  - [x] OAuth 2.0 / OpenID for Web
 - [ ] Matchmaking
 - [ ] Matchmaking
 
 
 # Design considerations
 # Design considerations

+ 0 - 11
project/ios/plugins/gamecenter/README.md

@@ -15,17 +15,6 @@ The GameCenter plugin revolves around an event polling system. Events are sent t
 ### Authorization
 ### Authorization
 
 
 `authenticate()` - Performs user authentication. Generates a new `authentication` event.
 `authenticate()` - Performs user authentication. Generates a new `authentication` event.
-
-```json
-{
-  "type": "authentication",
-  "result": "ok",
-  "alias": "eatingdumplings",
-  "displayName": "eatingdumplings",
-  "player_id": "T:_48001ab8bf56c9fdcdc242bac5db3b0d"
-}
-```
-
 `is_authenticated()` - Returns authentication state.
 `is_authenticated()` - Returns authentication state.
 
 
 ### GameCenter methods
 ### GameCenter methods