Skip to content

aum7/UPBGE-Docs

 
 

Repository files navigation

UPBGE Manual

Welcome to the official repository of UPBGE's Manual and Python API, the UPBGE source-code repository can be found here.

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 repository directly.

Local Build Requirements

To build this documentation you'll need:

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 directory.

License

UPBGE itself is released under the GNU General Public License.

Except where otherwise noted, the content of the UPBGE Manual is available under a Creative Commons Attribution-ShareAlike 4.0 International License 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:

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)
  • You!

Releases

No releases published

Packages

No packages published

Languages

  • Python 54.1%
  • CSS 40.4%
  • Batchfile 3.1%
  • Makefile 2.4%