Skip to content

Commit 84aadb0

Browse files
syntaxerror247syntaxerror247
committed
Overview and Installation page
1 parent 44400f8 commit 84aadb0

File tree

4 files changed

+138
-25
lines changed

4 files changed

+138
-25
lines changed

‎.github/workflows/documentation.yml‎

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
1-
# This is a basic workflow to help you get started with Actions
1+
name: Documentation
22

3-
name: CI
4-
5-
# Controls when the workflow will run
63
on:
7-
# Triggers the workflow on push or pull request events but only for the "master" branch
84
push:
95
branches: [ "master" ]
106
pull_request:
117
branches: [ "master" ]
12-
13-
# Allows you to run this workflow manually from the Actions tab
148
workflow_dispatch:
159

16-
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
1714
jobs:
18-
# This workflow contains a single job called "build"
19-
build:
20-
# The type of runner that the job will run on
15+
deploy:
16+
environment:
17+
name: github-pages
18+
url: ${{ steps.deployment.outputs.page_url }}
2119
runs-on: ubuntu-latest
22-
23-
# Steps represent a sequence of tasks that will be executed as part of the job
2420
steps:
25-
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
26-
- uses: actions/checkout@v4
27-
28-
# Runs a single command using the runners shell
29-
- name: Run a one-line script
30-
run: echo Hello, world!
31-
32-
# Runs a set of commands using the runners shell
33-
- name: Run a multi-line script
34-
run: |
35-
echo Add other actions to build,
36-
echo test, and deploy your project.
21+
- uses: actions/configure-pages@v5
22+
- uses: actions/checkout@v5
23+
- uses: actions/setup-python@v5
24+
with:
25+
python-version: 3.x
26+
- run: pip install zensical
27+
- run: zensical build --clean
28+
- uses: actions/upload-pages-artifact@v4
29+
with:
30+
path: site
31+
- uses: actions/deploy-pages@v4
32+
id: deployment

‎docs/Installation.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
icon: lucide/package
3+
---
4+
5+
# Installation
6+
7+
This guide walks you through installing the Godot Google Play Billing Plugin and preparing your project for Android in-app purchases.
8+
9+
## Requirements
10+
11+
Before installing, make sure you have:
12+
13+
- A project using Godot Engine 4.4+
14+
- Android export configured in Godot
15+
- An application in Google Play Console
16+
- An Android device for testing
17+
18+
## Install the Plugin
19+
20+
1. Download the latest release from the [Releases](https://github.com/godot-sdk-integrations/godot-google-play-billing/releases) page.
21+
2. Unzip and copy the plugin to your project's `addons` folder:
22+
```
23+
[Project root]/addons/GodotGooglePlayBilling/
24+
```
25+
3. Open your project in Godot.
26+
4. In main menu, go to `Project > Project Settings > Plugins`, and enable **GodotGooglePlayBilling**.
27+
28+
The plugin is now active in your project.
29+
30+
## Configure Android Export
31+
32+
1. In main menu, go to `Project > Export`.
33+
2. Add an Android export preset if you dont have one.
34+
3. Ensure:
35+
- Package name matches your Google Play Console app
36+
- Internet permission is enabled
37+
- The project is signed with a release keystore
38+
39+
Export settings must match your Google Play configuration for billing to work correctly.
40+
41+
## Upload a Test Build
42+
43+
Google Play Billing only works with builds uploaded to Google Play.
44+
45+
1. Export a signed Android AAB build.
46+
2. Upload it to:
47+
- Internal testing track (recommended)
48+
- Closed testing track
49+
3. Add your Google account as a tester.
50+
4. Install the app from the Play Store testing link.

‎docs/index.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
icon: lucide/file-text
3+
---
4+
5+
# Overview
6+
7+
**GodotGooglePlayBilling** plugin brings in-app purchases to Android games built with Godot Engine using the [Google Play Billing library](https://developer.android.com/google/play/billing).
8+
9+
It provide a straightforward way to sell digital content in Godot games with minimal setup and simple API.
10+
11+
## Features
12+
13+
- One-time product purchases
14+
- Subscription support
15+
- Simple signal-based API
16+
17+
## Platform Support
18+
19+
- Android devices distributed through Google Play
20+
- Requires a configured Google Play Console app
21+
22+
## Typical Use Cases
23+
24+
- Unlock premium features
25+
- Remove ads
26+
- Sell consumables (coins, lives, etc.)
27+
- Offer subscriptions

‎zensical.toml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[project]
2+
site_name = "Godot Google Play Billing"
3+
site_description = "Godot Android plugin for Google Play Billing."
4+
site_author = "syntaxerror247"
5+
6+
nav = [
7+
"index.md",
8+
"Installation.md"
9+
]
10+
11+
copyright = """
12+
Copyright © Godot Engine Contributors
13+
"""
14+
15+
[project.theme]
16+
language = "en"
17+
favicon = "https://godotengine.org/assets/press/icon_color.svg"
18+
logo = "https://godotengine.org/assets/press/icon_color.svg"
19+
20+
21+
features = [
22+
"content.code.annotate",
23+
"content.code.copy",
24+
"content.code.select",
25+
"navigation.footer",
26+
"navigation.instant",
27+
"navigation.instant.progress",
28+
"navigation.top",
29+
"search.highlight"
30+
]
31+
32+
[[project.theme.palette]]
33+
scheme = "default"
34+
toggle.icon = "lucide/sun"
35+
toggle.name = "Switch to dark mode"
36+
37+
[[project.theme.palette]]
38+
scheme = "slate"
39+
toggle.icon = "lucide/moon"
40+
toggle.name = "Switch to light mode"

0 commit comments

Comments
 (0)