Skip to content

Commit

Permalink
Clarify that Pygame_SDL2 is mostly a Ren'Py dependency at this point.
Browse files Browse the repository at this point in the history
  • Loading branch information
renpytom committed Jul 25, 2022
1 parent 7f814e9 commit bed8099
Showing 1 changed file with 9 additions and 33 deletions.
42 changes: 9 additions & 33 deletions README.rst
Expand Up @@ -3,19 +3,12 @@ Pygame_sdl2
===========

Pygame_sdl2 is a reimplementation of the Pygame API using SDL2 and
related libraries. The initial goal of this project are to allow
games written using the pygame API to run on SDL2 on desktop and
mobile platforms. We will then evolve the API to expose SDL2-provided
functionality in a pythonic manner.
related libraries. While in the past it was meant to support multiple
applications, it only saw adoption as technology underlying Ren'Py, and
is currently being supported for that purpose.

Downloads
---------

Nightly builds are available from:

https://nightly.renpy.org/current/

An official release will be coming to pypi shortly.
The `original pygame <https://www.pygame.org>`_ now runs on SDL2, and should
be used for most applications.

License
-------
Expand All @@ -28,6 +21,7 @@ determine its licensing status.
See the COPYING.ZLIB and COPYING.LGPL21 files for details - you'll need
to comply with both to distribute software containing pygame_sdl2.


Current Status
--------------

Expand Down Expand Up @@ -76,17 +70,6 @@ Current omissions include:
* Support for palette functions, which only apply to 8-bit surfaces.


Documentation
-------------

The latest documentation can be found at:

http://pygame-sdl2.readthedocs.org/

An Android packaging example can be found at:

https://github.com/renpytom/rapt-pygame-example

Building
--------

Expand Down Expand Up @@ -137,6 +120,8 @@ Finally, build and install pygame_sdl2 by running::
Windows
^^^^^^^

**These instructions are likely out of date.**

To build on windows, change into the pygame_sdl2 checkout, clone
renpy/pygame_sdl2_windeps using a command like::

Expand Down Expand Up @@ -194,19 +179,10 @@ Pygame_sdl2 is designed as a complete replacement for pygame.
If you try to use both the `pygame_sdl2` and `pygame` libraries in the same program
you may encounter errors; such as library import failures in frozen programs.


Contributing
------------

We're looking for people to contribute to pygame_sdl2 development. For
simple changes, just give us a pull request. Before making a change that
is a lot of work, it might make sense to send us an email to ensure we're
not already working on it.

Credits
-------

Pygame_sdl2 is written by:
Pygame_sdl2 was written by:

* Patrick Dawson <pat@dw.is>
* Tom Rothamel <tom@rothamel.us>
Expand Down

0 comments on commit bed8099

Please sign in to comment.