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.
.. code:: sh
pip install fake-bge-module-<version>
If you install fake-bge-module for UPBGE 0.2.5, run below command.
.. code:: sh
pip install fake-bge-module-0.2.5
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.
.. code:: sh
pip install fake-bge-module-latest
*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/
latest https://pypi.org/project/fake-bge-modulelatest/
======= ===============================================
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": "https://github.com/nutti/fake-bge-module",
"name": "fake-bge-module-0.2.5",
"maintainer": "nutti",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "nutti.metro@gmail.com",
"keywords": "",
"author": "nutti",
"author_email": "nutti.metro@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e3/76/019b5464f7f01bdb41d3ba05c17bde79b1bbd2f05a383889578a8e593a1b/fake-bge-module-0.2.5-20231118.tar.gz",
"platform": "Windows",
"description": "Fake Blender Game Engine (BGE) Python API module collection: fake-bge-module\n============================================================================\n\nfake-bge-module is the collections of the fake Blender Game Engine (BGE)\nPython API modules for the code completion in commonly used IDEs.\n\n*Note: The similar project for Blender is available\non*\\ `fake-bpy-module <https://github.com/nutti/fake-bpy-module>`__\\ *which\ntargets*\\ `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* `GitHub\nSponsors <https://github.com/sponsors/nutti>`__. *See*\\ `the\ncontribution document <CONTRIBUTING.md>`__\\ *for the detail of* *the\nsupport.*\n\nRequirements\n------------\n\nfake-bge-module uses typing module and type hints which are available\nfrom Python 3.7. Check your Python version is >= 3.7.\n\nInstall\n-------\n\nfake-bge-module can be installed via a pip package, or pre-generated\nmodules. You can also generate and install modules manually.\n\nInstall via pip package\n~~~~~~~~~~~~~~~~~~~~~~~\n\n| fake-bge-module is registered to PyPI.\n| You can install it as a pip package.\n\n.. code:: sh\n\n pip install fake-bge-module-<version>\n\nIf you install fake-bge-module for UPBGE 0.2.5, run below command.\n\n.. code:: sh\n\n pip install fake-bge-module-0.2.5\n\nIf you install fake-bpy-module for Blender latest build (master branch\ndaily build powered by\n`nutti/upbge-daily-build <https://github.com/nutti/upbge-daily-build>`__),\nrun below command.\n\n.. code:: sh\n\n pip install fake-bge-module-latest\n\n*Note: For PyCharm users, change the value\n``idea.max.intellisense.filesize`` in ``idea.properties`` file to more\nthan 2600 because some modules have the issue of being too big for\nintelliSense to work.*\n\nSupported UPBGE Version\n^^^^^^^^^^^^^^^^^^^^^^^\n\n======= ===============================================\nVersion PyPI\n======= ===============================================\n0.2.5 https://pypi.org/project/fake-bge-module-0.2.5/\nlatest https://pypi.org/project/fake-bge-modulelatest/\n======= ===============================================\n\nInstall via pre-generated modules\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDownload Pre-generated modules from `Release\npage <https://github.com/nutti/fake-bge-module/releases>`__.\n\nThe process of installation via pre-generated modules is different by\nIDE. See 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\n module) <docs/setup_all_text_editor.md>`__\n\nGenerate Modules Manually\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nYou can also generate modules manually. See `Generate\nModules <docs/generate_modules.md>`__ for detail.\n\nChange Log\n----------\n\nSee `CHANGELOG.md <CHANGELOG.md>`__\n\nBug report / Feature request / Disscussions\n-------------------------------------------\n\nIf you want to report bug, request features or discuss about this\nadd-on, see `ISSUES.md <ISSUES.md>`__.\n\nContribution\n------------\n\nIf you want to contribute to this project, see\n`CONTRIBUTING.md <CONTRIBUTING.md>`__.\n\nProject Authors\n---------------\n\nOwner\n~~~~~\n\n`@nutti <https://github.com/nutti>`__\n\n| Indie Game/Application Developer.\n| Especially, I spend most time to improve Blender and Unreal Game\n Engine via providing 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\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Collection of the fake Blender Game Engine (BGE) Python API module for the code completion.",
"version": "20231118",
"project_urls": {
"Bug Tracker": "https://github.com/nutti/fake-bge-module/issues",
"Documentation": "https://github.com/nutti/fake-bge-module/blob/master/README.md",
"Homepage": "https://github.com/nutti/fake-bge-module",
"Source Code": "https://github.com/nutti/fake-bge-module"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d70b0bc0414ed632d4056a75919cb6b3799b3f31e9cbc4d1540ee426c08a22cf",
"md5": "c26f1d26020046e22c04cadd452cc8d7",
"sha256": "91f9c1e631e05eacffc13229b38039fbd4a4b8489124858374a8f159a646e9a4"
},
"downloads": -1,
"filename": "fake_bge_module_0.2.5-20231118-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c26f1d26020046e22c04cadd452cc8d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 761837,
"upload_time": "2023-11-18T11:28:14",
"upload_time_iso_8601": "2023-11-18T11:28:14.161413Z",
"url": "https://files.pythonhosted.org/packages/d7/0b/0bc0414ed632d4056a75919cb6b3799b3f31e9cbc4d1540ee426c08a22cf/fake_bge_module_0.2.5-20231118-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e376019b5464f7f01bdb41d3ba05c17bde79b1bbd2f05a383889578a8e593a1b",
"md5": "50a6a399bb4f3fc1e9503268e1a7a999",
"sha256": "7a1ec3fbade154a54b4ff0c80476cc62458452f595eaecc3d8e39971df3c57ff"
},
"downloads": -1,
"filename": "fake-bge-module-0.2.5-20231118.tar.gz",
"has_sig": false,
"md5_digest": "50a6a399bb4f3fc1e9503268e1a7a999",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 651962,
"upload_time": "2023-11-18T11:28:16",
"upload_time_iso_8601": "2023-11-18T11:28:16.275391Z",
"url": "https://files.pythonhosted.org/packages/e3/76/019b5464f7f01bdb41d3ba05c17bde79b1bbd2f05a383889578a8e593a1b/fake-bge-module-0.2.5-20231118.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-18 11:28:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nutti",
"github_project": "fake-bge-module",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "yapf",
"specs": [
[
"==",
"0.25.0"
]
]
},
{
"name": "tqdm",
"specs": [
[
"==",
"4.46.0"
]
]
},
{
"name": "wheel",
"specs": [
[
"~=",
"0.34"
]
]
}
],
"lcname": "fake-bge-module-0.2.5"
}