updated discord sdk docs

This commit is contained in:
2024-03-02 23:35:44 +01:00
parent 1adf6bb499
commit 0565fc3848
2 changed files with 21 additions and 20 deletions

View File

@@ -3,44 +3,47 @@ layout: ../../../layouts/DocsLayout.astro
repo: discord-sdk-godot
title: Building
---
# How to build
1. Clone the project
2. Install [python](https://www.python.org/downloads/)
3. Install scons via pip with
```sh
pip install scons
```
and make sure to put scons on your PATH or replace "scons" with a scons run command<br/>
<br/>
4. Run this command
```sh
python setup.py
```
5. and build the project with
```sh
python build.py
```
There is a prompt how it should start Godot (if `godot` is on PATH) to test the addon fast directly.
<br/>
<br />
4. Run this command ```sh python setup.py ``` 5. and build the project with ```sh
python build.py ``` There is a prompt how it should start Godot (if `godot` is on
PATH) to test the addon fast directly.
<br />
**or** run
```sh
scons
```
and
```sh
scons target=template_release
```
<br/>
<br />
6. Now the addon should be installed in the project folder of the repo and can be exported with
```sh
python release.py
```
# MacOS Support
:::warn
MacOS is supported but not included in this project releases. <br/>
You have to build it yourself because signing costs money we don't want to pay currently.<br/>
You have to sign the binding dylib to use it. The official Discord Game SDK dylib is already signed by Discord.<br/>
It should be possible to run the dylib for testing before signing it but i haven't tested it yet.<br/>
:::
:::assert{title="Info"}
MacOS is fully supported but its building process is not fully documented yet.
:::

View File

@@ -19,8 +19,6 @@ features: [
The GameSDK's Achievements, Applications, Voice, Images, Lobbies, Networking, Storage, and Store (purchases and discounts) features have been deprecated and will not be added. <br /> However the rest is and will still be supported by Discord.
:::
**[![apple](https://github.com/vaporvee/discord-sdk-godot/assets/80621863/6d2c7a54-bfc9-4c8d-955a-40fa5c9e8c74)About MacOS Support](/docs/discord-sdk-godot/building#macos-support)**<br />
:::warn
The plugin only works with 4.2 and above for the current version
:::