Skip to content

Commit e63fc67

Browse files
dsnopekdsnopek
authored
Merge pull request #4 from dsnopek/update-docs-readme-for-release
Update the README and docs in preparation for the 1.0.0 release
2 parents 6df0ebf + 5f38628 commit e63fc67

File tree

7 files changed

+116
-79
lines changed

7 files changed

+116
-79
lines changed

‎README.md‎

Lines changed: 16 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
The toolkit exposes Meta SDKs (e.g Platform SDK), as well as Meta utilities for XR development with the Godot Engine.
44

5-
**Note:**
6-
- Use of the toolkit requires **Godot 4.3** or higher.
5+
> [!WARNING]
6+
>
7+
> Use of the toolkit requires **Godot 4.3** or higher.
78
89
## Build instructions
910

@@ -33,42 +34,16 @@ gradlew.bat buildToolkit
3334

3435
## Using the Platform SDK
3536

36-
Before you can use the Platform SDK, you need to:
37-
38-
1. [Create a developer account](https://developer.oculus.com/sign-up/) for Meta Quest.
39-
2. Create an app within the Meta Quest [Developer Dashboard](https://developer.oculus.com/manage/).
40-
3. Visit the "API" tab within the developer dashboard for your app, and make note of your "App ID" - you'll need this to initialize the Platform SDK.
41-
4. Make a release build of your application, using the real "Unique Name" and release keystore. At this point, your application probably doesn't do much, which is fine.
42-
5. Upload this build using the [Meta Quest Developer Hub](https://developer.oculus.com/meta-quest-developer-hub/) to the ALPHA channel.
43-
6. Complete a [Data Use Checkup](https://developer.oculus.com/resources/publish-data-use/) (DUC), including all the features of the Platform SDK you intend to use. You won't have access to any features you don't include in your DUC.
44-
7. Wait for your DUC to be approved.
45-
46-
After that process is complete, you'll be able to use the Platform SDK:
47-
48-
```gdscript
49-
func setup_meta_platform_sdk():
50-
var result: MetaPlatformSDK_Message
51-
52-
# Replace "1234" with your App ID.
53-
result = await MetaPlatformSDK.initialize_platform_async("1234").completed
54-
if result.is_error():
55-
print("Unable to initialize the platform SDK: ", result.error)
56-
return
57-
58-
# Check that the user owns this app and is entitled to use it.
59-
result = await MetaPlatformSDK.entitlement_get_is_viewer_entitled_async().completed
60-
if result.is_error():
61-
print("The user isn't entitled: ", result.error)
62-
return
63-
64-
# Get the list of the user's friends who also own this app.
65-
# NOTE: This will only work if you requested access to "Friends" on your DUC (see earlier instructions).
66-
result = await MetaPlatformSDK.user_get_logged_in_user_friends_async().completed
67-
if result.is_error():
68-
print("Unable to get friends: ", result.error)
69-
return
70-
71-
print("My friends:")
72-
for user in result.data:
73-
print("- ", user)
74-
```
37+
See [Getting Started with the Meta Platform SDK](https://godot-sdk-integrations.github.io/godot-meta-toolkit/manual/platform_sdk/getting_started.html) in the official docs.
38+
39+
## Documentation
40+
41+
This README is intentionally kept short.
42+
43+
See the [official documentation](https://godot-sdk-integrations.github.io/godot-meta-toolkit/) for more information.
44+
45+
## Maintenance and Sponsorship
46+
47+
This project is maintained by [W4 Games](https://www.w4games.com/) with sponsorship from [Meta](https://www.meta.com/).
48+
49+
Contributions from the community are welcome!

‎doc_classes/MetaPlatformSDK.xml‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,6 @@
55
</brief_description>
66
<description>
77
The [b]MetaPlatformSDK[/b] singleton is your main entry-point for working with Meta's Platform SDK.
8-
Before you can use the Platform SDK, you'll need to:
9-
1. [url=https://developer.oculus.com/sign-up/]Create a developer account[/url] for Meta Quest.
10-
2. Create an app within the Meta Quest [url=https://developer.oculus.com/manage/]Developer Dashboard[/url].
11-
3. Visit the "API" tab within the developer dashboard for your app, and make note of your "App ID" - you'll need this to initialize the Platform SDK.
12-
4. Make a release build of your application, using the real "Unique Name" and release keystore. At this point, your application probably doesn't do much, which is fine.
13-
5. Upload this build using the [url=https://developer.oculus.com/meta-quest-developer-hub/]Meta Quest Developer Hub[/url] to the ALPHA channel.
14-
6. Complete a [url=https://developer.oculus.com/resources/publish-data-use/]Data Use Checkup[/url] (DUC), including all the features of the Platform SDK you intend to use. You won't have access to any features you don't include in your DUC.
15-
7. Wait for your DUC to be approved.
16-
After that process is complete, you'll be able to use the Platform SDK, for example:
17-
[codeblock]
18-
func setup_meta_platform_sdk():
19-
var result: MetaPlatformSDK_Message
20-
21-
# Replace "1234" with your App ID.
22-
result = await MetaPlatformSDK.initialize_platform_async("1234").completed
23-
if result.is_error():
24-
print("Unable to initialize the platform SDK: ", result.error)
25-
return
26-
27-
# Check that the user owns this app and is entitled to use it.
28-
result = await MetaPlatformSDK.entitlement_get_is_viewer_entitled_async().completed
29-
if result.is_error():
30-
print("The user isn't entitled: ", result.error)
31-
return
32-
33-
# Get the list of the user's friends who also own this app.
34-
# NOTE: This will only work if you requested access to "Friends" on your DUC (see earlier instructions).
35-
result = await MetaPlatformSDK.user_get_logged_in_user_friends_async().completed
36-
if result.is_error():
37-
print("Unable to get friends: ", result.error)
38-
return
39-
40-
print("My friends:")
41-
for user in result.data:
42-
print("- ", user)
43-
[/codeblock]
448
Be sure to initialize the Platform SDK using [method initialize_platform_async] or [method initialize_platform] before calling any other methods.
459
</description>
4610
<tutorials>

‎docs/index.rst‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,33 @@
11
Welcome to the Godot Meta Toolkit documentation!
22
================================================
33

4-
The **Godot Meta Toolkit** is a GDExtension for Godot 4, that aims to make it easier to
5-
develop Godot applications for Meta Quest headsets.
4+
The **Godot Meta Toolkit** is a GDExtension for Godot 4.3+, that exposes Meta SDKs (e.g Platform SDK), as well as Meta utilities for XR development with the Godot Engine.
5+
6+
Key Features
7+
------------
8+
9+
- Integration with the :ref:`Platform SDK<manual_platform_sdk_getting_started>`
10+
- :ref:`Tool for configuring the Meta XR Simulator<manual_xr_simulator>` to work with Godot
11+
12+
Maintenance and Sponsorship
13+
---------------------------
14+
15+
This project is maintained by `W4 Games <https://www.w4games.com/>`_ with sponsorship from `Meta <https://www.meta.com/>`_.
16+
17+
Contributions from the community are welcome!
618

719
.. Below is the main table-of-content tree of the documentation website.
820
It is hidden on the page itself, but it makes up the sidebar for navigation.
921
22+
.. toctree::
23+
:hidden:
24+
:maxdepth: 1
25+
:caption: Manual
26+
:name: manual
27+
28+
manual/platform_sdk/index
29+
manual/xr_simulator
30+
1031
.. toctree::
1132
:hidden:
1233
:maxdepth: 1

‎docs/manual/img/xr_simulator_tool.png‎

38.4 KB
Loading

‎docs/manual/platform_sdk/getting_started.rst‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _manual_platform_sdk_getting_started:
2+
3+
Getting Started
4+
===============
5+
6+
Before you can use the Platform SDK, you need to:
7+
8+
1. `Create a developer account <https://developer.oculus.com/sign-up/>`_ for Meta Quest.
9+
2. Create an app within the Meta Quest `Developer Dashboard <https://developer.oculus.com/manage/>`_.
10+
3. Visit the "API" tab within the developer dashboard for your app, and make note of your "App ID" - you'll need this to initialize the Platform SDK.
11+
4. Make a release build of your application, using the real "Unique Name" and release keystore. At this point, your application probably doesn't do much, which is fine.
12+
5. Upload this build using the `Meta Quest Developer Hub <https://developer.oculus.com/meta-quest-developer-hub/>`_ to the ALPHA channel.
13+
6. Complete a `Data Use Checkup <https://developer.oculus.com/resources/publish-data-use/>`_ (DUC), including all the features of the Platform SDK you intend to use. You won't have access to any features you don't include in your DUC.
14+
7. Wait for your DUC to be approved.
15+
16+
After that process is complete, you'll be able to use the Platform SDK:
17+
18+
.. code-block:: gdscript
19+
20+
func setup_meta_platform_sdk():
21+
var result: MetaPlatformSDK_Message
22+
23+
# Replace "1234" with your App ID.
24+
result = await MetaPlatformSDK.initialize_platform_async("1234").completed
25+
if result.is_error():
26+
print("Unable to initialize the platform SDK: ", result.error)
27+
return
28+
29+
# Check that the user owns this app and is entitled to use it.
30+
result = await MetaPlatformSDK.entitlement_get_is_viewer_entitled_async().completed
31+
if result.is_error():
32+
print("The user isn't entitled: ", result.error)
33+
return
34+
35+
# Get the list of the user's friends who also own this app.
36+
# NOTE: This will only work if you requested access to "Friends" on your DUC (see earlier instructions).
37+
result = await MetaPlatformSDK.user_get_logged_in_user_friends_async().completed
38+
if result.is_error():
39+
print("Unable to get friends: ", result.error)
40+
return
41+
42+
print("My friends:")
43+
for user in result.data:
44+
print("- ", user)
45+
46+
For more information, see the API docs for the :ref:`MetaPlatformSDK<class_metaplatformsdk>` singleton. It's the entry point for doing anything with the Meta Platform SDK.

‎docs/manual/platform_sdk/index.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:github_url: hide
2+
3+
Platform SDK
4+
============
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
:name: toc-manual-platform-sdk
9+
10+
getting_started

‎docs/manual/xr_simulator.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _manual_xr_simulator:
2+
3+
XR Simulator
4+
============
5+
6+
The `Meta XR Simulator <https://developers.meta.com/horizon/downloads/package/meta-xr-simulator>`_ allows developers to test XR applications on their desktop computer (Windows or MacOS),
7+
leading to faster iteration, because the app doesn't need to be deployed to the headset, and the developer doesn't need to constantly put the headset on and off.
8+
9+
Godot can be configured to launch the Meta XR Simulator when you run your game, and the Godot Meta Toolkit includes a tool to help you with that configuration!
10+
11+
Step-by-step instructions
12+
-------------------------
13+
14+
1. Download the `Meta XR Simulator <https://developers.meta.com/horizon/downloads/package/meta-xr-simulator>`_ and extract it somewhere on your computer.
15+
16+
2. In the Godot editor, click **Project** -> **Tools** -> **Configure Meta XR Simulator...**
17+
18+
.. image:: img/xr_simulator_tool.png
19+
:alt: Shows the "Configure Meta XR Simulator..." option in the menu
20+
21+
3. Follow the instructions in the dialog, in order to point Godot to the location where you extracted the Meta XR Simulator.

0 commit comments

Comments
 (0)