Skip to content

Commit

Permalink
Add credits to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jepebe committed Oct 14, 2020
1 parent ed5636f commit f433904
Showing 1 changed file with 13 additions and 21 deletions.
34 changes: 13 additions & 21 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,12 @@
# PXNG

*PXNG* a library that provides a simplified API for working with pixels,
drawing shapes, writing text and interacting with input devices.
It is inspired by the *olcPixelGameEngine* by OneLoneCoder.
*PXNG* is a python library that provides a simplified API for working with pixels, drawing shapes, writing text and interacting with input devices. It is inspired by the *olcPixelGameEngine* by OneLoneCoder.

## What it can do:
- Create a window for drawing. The window supports rendering at a lower
virtual resolution.
- Create a window for drawing. The window supports rendering at a lower virtual resolution.
- Render text. The built in font is C64 styled.
- Render filled shapes. Currently only rectangles. :)
- Render sprites. Sprites can be scaled and blend with the background.
Created from NumPy arrays. It is also possible to use *imageio* to
read files directly in to sprites. Any changes in the data buffer of the
sprite can be updated in the live rendering.
- Render sprites. Sprites can be scaled and blend with the background. Created from NumPy arrays. It is also possible to use *imageio* to read files directly in to sprites. Any changes in the data buffer of the sprite can be updated in the live rendering.
- Animated sprites. Using a sprite sheet *pxng* supports animation.
- Poll the keyboard for events.

Expand All @@ -22,22 +16,15 @@ The aim is to make this `pip install pxng` but we are not there yet.


## Examples
In the examples folder there are three applications that show how the
library is used to perform different tasks. These examples does not
show the most efficient way of doing the task, however.
In the examples folder there are three applications that show how the library is used to perform different tasks. These examples does not show the most efficient way of doing the task, however.

1. Palette - By abusing `fill_rect` the following screenshot was created.
The live rendering animates the color of the lower **HSL** view and all
of the **RGB** views.
1. Palette - By abusing `fill_rect` the following screenshot was created. The live rendering animates the color of the lower **HSL** view and all of the **RGB** views.
![Screenshot of palette.py](images/palette.png)

2. Animated Sprites - Shows some of the possibilities of rendering sprite
sheets. All of the visible sprites in the screenshot are animated by
sub indexing the sprite sheet in a 8x8 grid.
2. Animated Sprites - Shows some of the possibilities of rendering sprite sheets. All of the visible sprites in the screenshot are animated by sub indexing the sprite sheet in a 8x8 grid.
![Screenshot of animated_sprites.py](images/animated_sprites.png)

3. Text Rendering - This example shows animated rendering of text.
The green field of hexadecimal numbers scrolls by as fast as it can.
3. Text Rendering - This example shows animated rendering of text. The green field of hexadecimal numbers scrolls by as fast as it can.
![Screenshot of text_rendering.py](images/text_rendering.png)


Expand All @@ -49,4 +36,9 @@ The green field of hexadecimal numbers scrolls by as fast as it can.
- olcPixelGameEngine - https://github.com/OneLoneCoder/olcPixelGameEngine
- Freetype - The code for generating bitmap fonts to OpenGL Display Lists is
copyrighted by Nicolas P. Rougier.
https://github.com/rougier/freetype-py/blob/master/examples/opengl.py
https://github.com/rougier/freetype-py/blob/master/examples/opengl.py

## Credits

- thekingphoenix and Bonsaiheldin for the character sprite
- para for particle effects

0 comments on commit f433904

Please sign in to comment.