https://github.com/godotsteam/godotsteam-docs
The repository for GodotSteam's full documentation.
https://github.com/godotsteam/godotsteam-docs
godot godot-engine godotengine godotsteam steam-api steamworks
Last synced: 2 months ago
JSON representation
The repository for GodotSteam's full documentation.
- Host: GitHub
- URL: https://github.com/godotsteam/godotsteam-docs
- Owner: GodotSteam
- License: mit
- Created: 2023-09-20T14:45:49.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-18T17:08:34.000Z (4 months ago)
- Last Synced: 2025-06-18T18:23:03.488Z (4 months ago)
- Topics: godot, godot-engine, godotengine, godotsteam, steam-api, steamworks
- Homepage: http://godotsteam.com/
- Size: 18.7 MB
- Stars: 17
- Watchers: 2
- Forks: 33
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.txt
Awesome Lists containing this project
README
# GodotSteam Documentation
This branch is stores the source code for the [GodotSteam](https://godotsteam.com) documentation website. It is made with [MKDocs](https://www.mkdocs.org/) and [Material For MKDocs](https://squidfunk.github.io/mkdocs-material/). Everyone is welcome to modify, correct, and add to the documentation!Local Edit And Build
---
To run the docs locally, you'll need to install MKDocs and Material For MKDocs:
```
pip install mkdocs
pip install mkdocs-material
```You also need to install the following plug-ins:
```
pip install mkdocs-badges
pip install mkdocs-rss-plugin
pip install "mkdocs-material[imaging]"
```GodotSteam Flavors
---
Pre-Compiles | Plug-ins | Server | Examples
--- | --- | --- | ---
[Godot 2.x](https://github.com/GodotSteam/GodotSteam/tree/godot2) | [GDNative](https://github.com/GodotSteam/GodotSteam/tree/gdnative) | [Server 3.x](https://github.com/GodotSteam/GodotSteam-Server/tree/godot3) | [Skillet](https://github.com/GodotSteam/Skillet)
[Godot 3.x](https://github.com/GodotSteam/GodotSteam/tree/godot3) | [GDExtension](https://github.com/GodotSteam/GodotSteam/tree/gdextension) | [Server 4.x](https://github.com/GodotSteam/GodotSteam-Server/tree/godot4) | ---
[Godot 4.x](https://github.com/GodotSteam/GodotSteam/tree/godot4) | --- | [GDNative](https://github.com/GodotSteam/GodotSteam-Server/tree/gdnative) | ---
[MultiplayerPeer](https://github.com/GodotSteam/MultiplayerPeer)| --- | [GDExtension](https://github.com/GodotSteam/GodotSteam-Server/tree/gdextension) | ---Donate
---
Pull-requests are the best way to help the project out but you can also donate through [Github Sponsors](https://github.com/sponsors/Gramps)!License
---
MIT license