Gearence is a third-party mobile application designed to provide a seamless reading experience for the Godot Engine Class Reference. Whether you are commuting or away from your workstation, Gearence allows you to browse documentation for Godot versions 2.0 through 4.x directly on your iOS or Android device.
Download on Google Play | Download on AppStore | Official Website
-
Multi-Version Support: Access documentation for Godot versions ranging from legacy 2.0 to the latest 4.x releases.
-
Advanced Navigation: Effortlessly switch between Classes, Functions, Signals, and Properties with full in-app redirection.
-
Fast Search: Quickly find the API information you need with an integrated search bar.
-
Reading Comfort:
-
Dark Mode: High-contrast theme for low-light environments.
-
Adjustable Text Size: Customize font sizes for better readability.
-
Code Highlighting: Includes JetBrains Mono for clean code block rendering.
-
Offline Access: Once synced, browse documentation without needing an active internet connection.
Gearence is built with Flutter. To build the project from source, you will need:
- Flutter SDK (Latest stable version)
- Android Studio / Xcode (for mobile deployment)
- Python 3 (for document generation scripts)
- Clone the repository:
git clone https://github.com/GodotDocMobile/Gearence.git
cd Gearence
- Install Flutter dependencies:
flutter pub get
- Run the app:
flutter run
The app fetches documentation directly from the official Godot repository. To update the XML documentation used in the app:
- Clone the Godot repository:
git clone https://github.com/godotengine/godot.git
- Install Python requirements:
pip install GitPython polib
# On Ubuntu 24.04+: sudo apt install python3-git python3-polib
- Run the update script:
Navigate to the
scriptsfolder and rungodot_repo.py, pointing it to your local Godot clone:
cd scripts
python3 godot_repo.py --godot_path /path/to/your/godot/repo
lib/: Main Flutter application logic.scripts/: Python scripts for pulling and processing Godot XML documentation.project_assets/: Branding assets(Store banner, Icon).xmls/: Stored class reference data.svgs/: Stored class icons.translations/： Stored translations.
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.
Gearence is an independent project and is not affiliated with the official Godot Engine team.