Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 22 additions & 25 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
# This is a basic workflow to help you get started with Actions
name: Documentation

name: CI

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "master" branch
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
permissions:
contents: read
pages: write
id-token: write
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest

# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4

# Runs a single command using the runners shell
- name: Run a one-line script
run: echo Hello, world!

# Runs a set of commands using the runners shell
- name: Run a multi-line script
run: |
echo Add other actions to build,
echo test, and deploy your project.
- uses: actions/configure-pages@v5
- uses: actions/checkout@v5
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install zensical
- run: zensical build --clean
- uses: actions/upload-pages-artifact@v4
with:
path: site
- uses: actions/deploy-pages@v4
id: deployment
51 changes: 51 additions & 0 deletions docs/Installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
icon: lucide/package
---

# Installation

This guide walks you through installing the Godot Google Play Billing Plugin and preparing your project for Android in-app purchases.

## Requirements

Before installing, make sure you have:

- A project using Godot Engine 4.4+
- Android export configured in Godot
- An application in Google Play Console
- An Android device for testing

## Install the Plugin

1. Download the latest release from the [Releases](https://github.com/godot-sdk-integrations/godot-google-play-billing/releases) page.
2. Unzip and copy the plugin to your project's `addons` folder:
```
[Project root]/addons/GodotGooglePlayBilling/
```
3. Open your project in Godot.
4. In main menu, go to `Project > Project Settings > Plugins`, and enable **GodotGooglePlayBilling**.

The plugin is now active in your project.

## Configure Android Export

1. In main menu, go to `Project > Export`.
2. Add an Android export preset if you dont have one.
3. Ensure:
- `gradle/use_gradle_build` is checked.
- Package name matches your Google Play Console app
- Internet permission is enabled
- The project is signed with a release keystore

Export settings must match your Google Play configuration for billing to work correctly.

## Upload a Test Build

Google Play Billing only works with builds uploaded to Google Play.

1. Export a signed Android AAB build.
2. Upload it to:
- Internal testing track (recommended)
- Closed testing track
3. Add your Google account as a tester.
4. Install the app from the Play Store testing link.
27 changes: 27 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
icon: lucide/file-text
---

# Overview

**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).

It provide a straightforward way to sell digital content in Godot games with minimal setup and simple API.

## Features

- One-time product purchases
- Subscription support
- Simple signal-based API

## Platform Support

- Android devices distributed through Google Play
- Requires a configured Google Play Console app

## Typical Use Cases

- Unlock premium features
- Remove ads
- Sell consumables (coins, lives, etc.)
- Offer subscriptions
Loading