GreenDjango / godot-bluetooth

[WIP] Bluetooth® module for Godot

Bluetooth Module

(WIP) Bluetooth® module for godot 3.x

Platform	Support	Dependencies
🪟 windows	❌
🐧x11	✔️	QT6
🍎osx	❌
📱android	❌

💾 Setup:

via submodule

1. git clone --depth 1 --recursive --single-branch --branch 3.4-stable https://github.com/godotengine/godot.git
2. open a terminal, cd godot/modules/, and run the following commands:
   git submodule add https://github.com/GreenDjango/godot-bluetooth.git bluetooth
cd ../
git submodule update --init --recursive

You can change --branch 3.4-stable to other release like 3.3.4-stable

via download

1. Download a godot source code release
2. Download the zip (godot-bluetooth-master) and extract it into the godot/modules/ folder.

🛠 Building

From linux

🐧Ubuntu dependencies

  sudo apt-get install qt6-connectivity-dev

🐧Fedora dependencies

  sudo dnf install qt6-qtconnectivity-devel

🐧Arch dependencies

  sudo yay -Syu qt6-connectivity

For compiling Godot under Linux or other Unix variants, the following is required.

Then, you can use scons -j8 platform=x11 for start compiling, where -j8 is the number of threads.

NOTE: use SCONS flags production=yes tools=yes target=release_debug for your editor and production=yes tools=no target=release for your templates.

Godot binary is create in the bin/ folder like bin/godot.x11.tools.64.

If you want to use separate editor settings for your own Godot builds and official releases, you can enable Self-contained mode by creating a file called ._sc_ or _sc_ in the bin/ folder.

From other

See the official docs for compilation instructions for every supported platform.

🎮 Godot

Class	Description	Access
Bluetooth	Basic Bluetooth manger (switch BT on, scan nearby device, etc)	Node & GDScrip
NetworkedMultiplayerBt	its purpose is to provide wrapper methods for all Bluetooth calls with a NetworkedMultiplayerPeer godot type friendly interface.	GDScrip

🤝 Setup to contribute

VScode is a good IDE for this project.

You can git clone this repository and Godot repository next to each other, and then link module for compile with scons custom_modules="../modules,/abs/path/to/modules,~/src/godot_modules" or a symlink in modules folder with ln -s ../../godot-bluetooth bluetooth.

For style, you need ms-vscode.cpptools. Next create .vscode/settings.json and add this line { "C_Cpp.clang_format_style": "file" }. Or use clang-format-13 cli without vscode.

TODO

• doc_classes need to be written for GDScript documentation.
• Provide some other singleton class.
• Use https://code.qt.io/cgit/qt/qtconnectivity.git/tree/src/bluetooth code for example
• [LINUX] build pipeline untested.
• [WIN] build pipeline untested.
• [OSX] build pipeline untested.
• [ANDROID] build pipeline untested.