https://github.com/upbge/upbge-docs
UPBGE Manual
https://github.com/upbge/upbge-docs
bge blender blender-game-engine documentation manual python sphinx-documentation upbge
Last synced: about 2 months ago
JSON representation
UPBGE Manual
- Host: GitHub
- URL: https://github.com/upbge/upbge-docs
- Owner: UPBGE
- Created: 2018-07-11T19:04:31.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T18:45:06.000Z (6 months ago)
- Last Synced: 2025-03-25T23:08:17.279Z (2 months ago)
- Topics: bge, blender, blender-game-engine, documentation, manual, python, sphinx-documentation, upbge
- Language: CSS
- Homepage: https://upbge.org/docs/latest/manual/index.html
- Size: 49.9 MB
- Stars: 22
- Watchers: 9
- Forks: 16
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# UPBGE Manual
## [View the latest build of this documentation](https://upbge.org/docs/latest/manual/index.html)
Welcome to the official repository of UPBGE's Manual and Python API, the UPBGE source-code repository can be found [here](https://github.com/UPBGE/blender).
You can contribute by opening an issue asking for a topic to be included in the documentation and/or opening a pull-request with the desired changes.
If you'd rather contribute several things directly ask for commit rights.
Once a change is committed, a build is automatically generated and the new changes pushed to the [upbge-docs](https://upbge.org/docs/latest/manual) repository directly.
## Local Build Requirements
To build this documentation you'll need:
- [Python 3](https://www.python.org/)
- [Sphinx](https://pypi.org/project/Sphinx/)
- [Read The Docs Theme for Sphinx](https://pypi.org/project/sphinx_rtd_theme/)
Once all dependencies are installed, simply open the console at the top-level directory and run the command:
`make html`
The documentation will than be built into the [build](https://github.com/upbge/upbge-docs-build) directory.
## License
UPBGE itself is released under the [GNU General Public License](http://www.gnu.org/copyleft/gpl.html).
Except where otherwise noted, the content of the UPBGE Manual is available under a
[Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)
or any later version. Excluded from the CC-BY-SA are also the used logos, trademarks,
icons, source code and Python scripts.
This UPBGE manual contains exclusive information from UPBGE Documentation Team, but it's also based on others manuals and articles whose authors are exposed below:
- The [Blender Manual](https://docs.blender.org/manual/en/dev/) by the [Blender Documentation Team](https://developer.blender.org/project/profile/53/) which is licensed under a [CC-BY-SA v4.0](https://creativecommons.org/licenses/by-sa/4.0/).
- The ["Game Development with Blender" book](https://github.com/mikepan/GameEngineBook) by [Mike Pan, Dalai Felinto and Other Authors](https://github.com/mikepan/GameEngineBook#credits) which is licensed under a [CC-BY-SA v4.0](https://creativecommons.org/licenses/by-sa/4.0/).
- The [UPBGE Manual](https://upbge.org/manual/index.html) by the [UPBGE Documentation Team](https://github.com/UPBGE/UPBGE-Docs##upbge-documentation-team) which is licensed under a [CC-BY-SA v4.0](https://creativecommons.org/licenses/by-sa/4.0/).
This means that when someone contributes to the manual, they don't hold exclusive copyright to their
text. They are of course, acknowledged and appreciated for their contribution. However, others' can change and improve any or all text in order to keep the manual consistent and up to date.
If you want to use the UPBGE manual in other sites or other formats, please attribute the
different authors and include hyperlinks (online) or URLs (in print) to the different
manuals that are pointed out above.
## UPBGE Documentation Team
- Antônio Froz (uayten)
- Denis Nicolas (denicolas)
- Guilherme Teres Nunes (UnidayStudio)
- Joel Gomes da Silva (joelgomes1994)
- Jorge Bernal (lordloki)
- Leopold A-C (IzaZed)
- marechal-p (wkk)
- NaincyKumariKnoldus
- RPaladin
- ShaunKulesa
- Tristan Porteries (panzergame)
- Ulysse Martin (youle31)
- Xavier Cho (mysticfall)
- (aum7)
- Zazoucoco0 (xavco63)
- You!