| Name | fake-bge-module JSON |
| Version |
20240918
JSON |
| download |
| home_page | None |
| Summary | Collection of the fake Blender Game Engine (BGE) Python API module for the code completion. |
| upload_time | 2024-09-18 06:40:13 |
| maintainer | nutti |
| docs_url | None |
| author | nutti |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Fake Blender Game Engine (BGE) Python API module collection: fake-bge-module
fake-bge-module is the collections of the fake Blender Game Engine (BGE) Python
API modules for the code completion in commonly used IDEs.
*Note: The similar project for Blender is available on
[fake-bpy-module](https://github.com/nutti/fake-bpy-module) which targets
[Blender](https://www.blender.org/).*
*To realize the long support of this project, your support is helpful.*
*You can support the development of this project via*
**[GitHub Sponsors](https://github.com/sponsors/nutti)**.
*See [the contribution document](CONTRIBUTING.md) for the detail of*
*the support.*
## Requirements
fake-bge-module uses typing module and type hints which are available from
Python 3.7. Check your Python version is >= 3.7.
## Install
fake-bge-module can be installed via a pip package, or pre-generated modules.
You can also generate and install modules manually.
### Install via pip package
fake-bge-module is registered to PyPI.
You can install it as a pip package.
#### Install a latest package
If you install fake-bpy-module for Blender latest build (master branch daily
build powered by [nutti/upbge-daily-build](https://github.com/nutti/upbge-daily-build)),
run below command.
```sh
pip install fake-bge-module
```
or, specify version "latest".
```sh
pip install fake-bge-module-latest
```
#### Install a version specific package
If you want to install a version specific package, run below command.
```sh
pip install fake-bge-module-<version>
```
If you install fake-bge-module for UPBGE 0.2.5, run below command.
```sh
pip install fake-bge-module-0.2.5
```
*Note: For PyCharm users, change the value `idea.max.intellisense.filesize` in
`idea.properties` file to more than 2600 because some modules have the issue of
being too big for intelliSense to work.*
##### Supported UPBGE Version
|Version|PyPI|
|---|---|
|0.2.5|[https://pypi.org/project/fake-bge-module-0.2.5/](https://pypi.org/project/fake-bge-module-0.2.5/)|
|latest|[https://pypi.org/project/fake-bge-module/](https://pypi.org/project/fake-bge-module/)|
||[https://pypi.org/project/fake-bge-module-latest/](https://pypi.org/project/fake-bge-module-latest/)|
### Install via pre-generated modules
Download Pre-generated modules from [Release page](https://github.com/nutti/fake-bge-module/releases).
The process of installation via pre-generated modules is different by IDE.
See the installation processes as follows for detail.
* [PyCharm](docs/setup_pycharm.md)
* [Visual Studio Code](docs/setup_visual_studio_code.md)
* [All Text Editor (Install as Python module)](docs/setup_all_text_editor.md)
### Generate Modules Manually
You can also generate modules manually.
See [Generate Modules](docs/generate_modules.md) for detail.
## Change Log
See [CHANGELOG.md](CHANGELOG.md)
## Bug report / Feature request / Disscussions
If you want to report bug, request features or discuss about this add-on, see
[ISSUES.md](ISSUES.md).
## Contribution
If you want to contribute to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).
## Project Authors
### Owner
[**@nutti**](https://github.com/nutti)
Indie Game/Application Developer.
Especially, I spend most time to improve Blender and Unreal Game Engine via
providing the extensions.
Support via [GitHub Sponsors](https://github.com/sponsors/nutti)
* CONTACTS: [Twitter](https://twitter.com/nutti__)
* WEBSITE: [Japanese Only](https://colorful-pico.net/)
Raw data
{
"_id": null,
"home_page": null,
"name": "fake-bge-module",
"maintainer": "nutti",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "nutti.metro@gmail.com",
"keywords": null,
"author": "nutti",
"author_email": "nutti.metro@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0c/28/6496226b0cb78bb34c92df62662eb044c451a6f731c3e88c61a78070dd54/fake_bge_module-20240918.tar.gz",
"platform": "Windows",
"description": "# Fake Blender Game Engine (BGE) Python API module collection: fake-bge-module\n\nfake-bge-module is the collections of the fake Blender Game Engine (BGE) Python\nAPI modules for the code completion in commonly used IDEs.\n\n*Note: The similar project for Blender is available on\n[fake-bpy-module](https://github.com/nutti/fake-bpy-module) which targets\n[Blender](https://www.blender.org/).*\n\n*To realize the long support of this project, your support is helpful.*\n*You can support the development of this project via*\n**[GitHub Sponsors](https://github.com/sponsors/nutti)**.\n*See [the contribution document](CONTRIBUTING.md) for the detail of*\n*the support.*\n\n## Requirements\n\nfake-bge-module uses typing module and type hints which are available from\nPython 3.7. Check your Python version is >= 3.7.\n\n## Install\n\nfake-bge-module can be installed via a pip package, or pre-generated modules.\nYou can also generate and install modules manually.\n\n### Install via pip package\n\nfake-bge-module is registered to PyPI. \nYou can install it as a pip package.\n\n#### Install a latest package\n\nIf you install fake-bpy-module for Blender latest build (master branch daily\nbuild powered by [nutti/upbge-daily-build](https://github.com/nutti/upbge-daily-build)),\nrun below command.\n\n```sh\npip install fake-bge-module\n```\n\nor, specify version \"latest\".\n\n```sh\npip install fake-bge-module-latest\n```\n\n#### Install a version specific package\n\nIf you want to install a version specific package, run below command.\n\n```sh\npip install fake-bge-module-<version>\n```\n\nIf you install fake-bge-module for UPBGE 0.2.5, run below command.\n\n```sh\npip install fake-bge-module-0.2.5\n```\n\n*Note: For PyCharm users, change the value `idea.max.intellisense.filesize` in\n`idea.properties` file to more than 2600 because some modules have the issue of\nbeing too big for intelliSense to work.*\n\n##### Supported UPBGE Version\n\n|Version|PyPI|\n|---|---|\n|0.2.5|[https://pypi.org/project/fake-bge-module-0.2.5/](https://pypi.org/project/fake-bge-module-0.2.5/)|\n|latest|[https://pypi.org/project/fake-bge-module/](https://pypi.org/project/fake-bge-module/)|\n||[https://pypi.org/project/fake-bge-module-latest/](https://pypi.org/project/fake-bge-module-latest/)|\n\n### Install via pre-generated modules\n\nDownload Pre-generated modules from [Release page](https://github.com/nutti/fake-bge-module/releases).\n\nThe process of installation via pre-generated modules is different by IDE.\nSee the installation processes as follows for detail.\n\n* [PyCharm](docs/setup_pycharm.md)\n* [Visual Studio Code](docs/setup_visual_studio_code.md)\n* [All Text Editor (Install as Python module)](docs/setup_all_text_editor.md)\n\n### Generate Modules Manually\n\nYou can also generate modules manually.\nSee [Generate Modules](docs/generate_modules.md) for detail.\n\n## Change Log\n\nSee [CHANGELOG.md](CHANGELOG.md)\n\n## Bug report / Feature request / Disscussions\n\nIf you want to report bug, request features or discuss about this add-on, see\n[ISSUES.md](ISSUES.md).\n\n## Contribution\n\nIf you want to contribute to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Project Authors\n\n### Owner\n\n[**@nutti**](https://github.com/nutti)\n\nIndie Game/Application Developer. \nEspecially, I spend most time to improve Blender and Unreal Game Engine via\nproviding the extensions.\n\nSupport via [GitHub Sponsors](https://github.com/sponsors/nutti)\n\n* CONTACTS: [Twitter](https://twitter.com/nutti__)\n* WEBSITE: [Japanese Only](https://colorful-pico.net/)\n",
"bugtrack_url": null,
"license": null,
"summary": "Collection of the fake Blender Game Engine (BGE) Python API module for the code completion.",
"version": "20240918",
"project_urls": {
"Bug Tracker": "https://github.com/nutti/fake-bge-module/issues",
"Documentation": "https://github.com/nutti/fake-bge-module/blob/main/README.md",
"Download": "https://github.com/nutti/fake-bge-module/releases",
"Homepage": "https://github.com/nutti/fake-bge-module",
"Release Notes": "https://github.com/nutti/fake-bge-module/blob/main/CHANGELOG.md",
"Source": "https://github.com/nutti/fake-bge-module"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd1ddf4fff9eca5b3d5834a86d4f1f0cec185848633bc9dc31e34f8bef316bc7",
"md5": "fea4a090168e8282037df7516a6c2f9a",
"sha256": "1caefa655d9e25e3934f05969da660787a76efde2da4a728a3282ccf03fe302e"
},
"downloads": -1,
"filename": "fake_bge_module-20240918-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fea4a090168e8282037df7516a6c2f9a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 1321629,
"upload_time": "2024-09-18T06:40:11",
"upload_time_iso_8601": "2024-09-18T06:40:11.493838Z",
"url": "https://files.pythonhosted.org/packages/dd/1d/df4fff9eca5b3d5834a86d4f1f0cec185848633bc9dc31e34f8bef316bc7/fake_bge_module-20240918-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c286496226b0cb78bb34c92df62662eb044c451a6f731c3e88c61a78070dd54",
"md5": "e02b12eb4ef27adf9fef090237dc25ca",
"sha256": "2f27446a19ccc39b282b813fd5663a47e52012f552a5bac6ddc876eb1aadc1d2"
},
"downloads": -1,
"filename": "fake_bge_module-20240918.tar.gz",
"has_sig": false,
"md5_digest": "e02b12eb4ef27adf9fef090237dc25ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1178337,
"upload_time": "2024-09-18T06:40:13",
"upload_time_iso_8601": "2024-09-18T06:40:13.510812Z",
"url": "https://files.pythonhosted.org/packages/0c/28/6496226b0cb78bb34c92df62662eb044c451a6f731c3e88c61a78070dd54/fake_bge_module-20240918.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 06:40:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nutti",
"github_project": "fake-bge-module",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fake-bge-module"
}
