Skip to content

Commit

Permalink
Merge #529
Browse files Browse the repository at this point in the history
529: Update Docs Homepage  r=pathunstrom a=Gideon357

I'm working on updating the docs homepage to be a bit more concise and readable. I also updated the theme to Alabaster. I have to go, but I will update this with a full list of changes in a little while. This PR closes #409 

Co-authored-by: Gideon Grinberg <[email protected]>
Co-authored-by: Gideon Grinberg <[email protected]>
  • Loading branch information
3 people authored Oct 23, 2020
2 parents 18b0729 + b5db31f commit afd4df0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 71 deletions.
Binary file added docs/_static/bearlogo-270.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 21 additions & 71 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,83 +1,33 @@
Welcome to PursuedPyBear's documentation!
=========================================

PursuedPyBear, also known as ``ppb``, exists to be an educational resource. Most
obviously used to teach computer science, it can be a useful tool for any topic
that a simulation can be helpful.
PursuedPyBear, also known as :code:`ppb`, exists to be an educational resource. Most obviously used to teach computer science, it can be a useful tool for any topic that a simulation can be helpful. At its core, :code:`ppb` provides a number of features that make it perfect for video games. The :code:`GameEngine` itself provides a pluggable subsystem architecture where adding new features is as simple as subclassing and extending :code:`System`.

A Game Engine
-------------
.. note :: This document explains the practical and technical details of :code:`ppb`. If you want to know more about what it is, its goals, or why you should use it, check out this page_ or our website_.
At its core, ``ppb`` provides a number of features that make it perfect
for video games. The ``GameEngine`` itself provides a pluggable
subsystem architecture where adding new features is as simple as
subclassing and extending ``System``. Additionally, it contains a state
stack of ``Scenes`` simple containers that let you organize game scenes
and UI screens in a simple way.
.. _page: https://github.com/ppb/pursuedpybear/blob/canon/README.md

The entire system uses an event system which is as extensible as the
rest of the system. Register new values to existing event types, and
even overwrite the defaults. Adding a new event system is as simple as
calling ``Engine.signal`` with a new datatype. Instead of a publisher
system the engine knows everything in its own scope and only calls
objects with appropriate callbacks. The most basic event is ``Update``
and your handlers should match the signature
``on_update(self, update_event, signal)``.
.. _website: https://ppb.dev

Guiding Principles
------------------
Using these docs
----------------
Our documentation is separated into practical steps and theoretical knowledge. The docs are made up of Tutorials, which allow you to learn quickly, and guides which bring you to a specific goal. We also have a standard API reference.

Because ``ppb`` started to be a game framework great for learning with,
the project has a few longterm goals:
As a New User
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Education Friendly
~~~~~~~~~~~~~~~~~~
We recommend that new users start with the :doc:`getting-started` Guide. This document assumes that you have basic programming knowledge. If you don't, check out the Python docs at https://docs.python.org.

Non-technical educators should feel comfortable after very little
training. While some programming knowledge is required, the ability to
think in objects and responses to events allows educators to only focus
on their lessons.

Idiomatic Python
~~~~~~~~~~~~~~~~

A project built on ``ppb`` should look like idiomatic Python. It also
should look like modern Python. As such, we often add new language
features as soon as they’re available, letting a new user always know
ppb runs on the latest Python.

Object Oriented and Event Driven
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``ppb`` games are built out of instances of objects. Each object only has
enough information to respond to the event provided, which always includes the
current ``BaseScene``. Because ``ppb`` doesn’t have a master list of events,
you can provide new ones simply to add more granular control over your game.

Hardware Library Agnostic
~~~~~~~~~~~~~~~~~~~~~~~~~

Because ``ppb`` strongly tries to be extensible and pluggable, each
hardware extension can provide its own hooks to ``ppb``, and you can
nearly seamlessly switch between various Python libraries.

Fun
~~~

One of the maintainers put it best:

If it’s not fun to use, we should redo it

ppb is about filing off the rough edges so that the joy of creation and
discovery are both emphasized. A new user should be able to build their
first game in a few hours, and continue exploring beyond that.
As an Experienced User
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Experienced users will likely want to start with our :doc:`reference/index` or our :doc:`howto/index`

.. toctree::
:maxdepth: 2
:caption: Contents:

getting-started
tutorials/index
howto/index
reference/index
discussion/index
:maxdepth: 2
:caption: Contents:

getting-started
tutorials/index
howto/index
reference/index
discussion/index

0 comments on commit afd4df0

Please sign in to comment.