Skip to content

Latest commit

 

History

History
149 lines (108 loc) · 6.27 KB

readme.md

File metadata and controls

149 lines (108 loc) · 6.27 KB
Raw

JorCademy Engine

This template is built for courses on programming, created for JorCademy. It will therefore mainly be used for educational purposes.

Contents

This section is used to quickly browse through the documentation.

Files

The following files are crucial to understand the inner workings of the template.

engine.py

This file is used to setup the PyGame renderer and to render all the drawable objects onto the screen. This file should not contain any gameplay code.

jorcademy.py

This file contains helper functions the developer can use to build their game in game.py. This file mainly contains functions which can be used to draw shapes and change the properties of the game screen. Besides, this module contains the draw_buffer, which contains all objects that need to be drawn onto the screen by the engine.
The JorCademy module provides the following building blocks at the moment (we suppose that the functionalities of these functions are clear):

  • is_key_down(key: str) -> bool
  • is_mouse_button_down(button: str) -> bool
  • is_scrolling_up() -> bool
  • is_scrolling_down() -> bool
  • screen(width: int, height: int) -> None
  • title(t: str) -> None
  • icon(name: str) -> None
  • backdrop(c: color) -> None
  • ellipse(c: color, x: float, y: float, w: float, h: float, rotation=0) -> None
  • rect(c: color, x: float, y: float, w: float, h: float, rotation=0) -> None
  • text(content: str, c: color, x: float, y: float, font="Nunito") -> None
  • image(url: str, x: float, y: float, scale: float, rotation=0) -> None
  • load_sound(path: str) -> Audio
  • play_sound(audio_obj: Audio) -> None
  • sleep(msec: int) -> None

primitives.py

This file contains classes for objects which can be drawn onto the screen. To be more precise, it contains the DrawableObject class and its subclasses. The most important method inside these classes is draw, which is used by the engine to easily draw different types of objects onto the screen.

game.py

This file is meant to contain the gameplay code of the game. It is the file the gameplay developer will work with. The other files are not relevant to the gameplay developer.

Dependencies

The template is supported by PyGame, a library used to create games with. In this template, it is used to set-up a screen to draw shapes on. In order to use this template, the installation of PyGame is required. This can be done through pip, Python's package manager, using the terminal. The following terminal command can be used to install PyGame:

pip install pygame

Besides the template uses pygbag, which is used to convert the PyGame project to WebAssembly. Pygbag can be installed using the following terminal command:

pip install pygbag

Practical information

This section contains some instructions on how to use this template properly, as well as a number of examples.

Setup & Draw

The templates starts of with two functions: setup and draw. Like with most game engines, the setup function is only executed once and can be used to initialize starting values of the game. The draw function is executed 60 times per second (once per frame) and can be used to update the game state (e.g, moving drawable objects).

def setup() -> None:
    pass

def draw() -> None:
    pass

Setting up the screen

Setting up the screen can be done using the screen function. Besides, the template provides helper functions to change properties of the screen, such as the title and backdrop (the latter can also be changed in the draw phase).

def setup() -> None:
    screen(800, 600)
    title("The best game ever made! UwU")
    backdrop((255, 255, 255))

Drawing & moving shapes

Drawing and moving shapes can be done in the draw functions. Adding shapes is fairly easy due to helper functions from the JorCademy module. The code snippet below shows a program which draws a circle and slowly moves the circle to the bottom right of the screen.

#Circle properties
x: float = 400
y: float = 300
w: int = 100
h: int = 100
circle_color: color = (12, 57, 100)

def setup() -> None:
    screen(800, 600)


def draw() -> None:
    global x
    global y
    global w
    global h
    global circle_color

    # Moving circle to the bottom-right
    x += 5
    y += 5

    # Drawing backdrop
    backdrop((0, 0, 0))

    # Drawing the circle 
    ellipse(circle_color, x, y, w, h)

Convert project to WebAssembly

If you've created a project, you may want to share it with friends and family. Fortunately, the JorCademy Engine makes this easy. You can convert the project to WebAssembly with the following terminal command:

pygbag --ume_block 0 main.py

If the conversion goes well, you can test the project while running the above command in the browser at the following address: http://localhost:8000/

In addition, a folder named build is created after the conversion. This folder contains two more folders: web and web-cache. If the version in the browser is satisfactory, and you want to upload the project to itch.io, you can convert the web folder to a .zip folder and upload this folder when creating a new itch.io project.

Maintenance

As this template is used for educational purposes, we are planning to keep it up-to-date for the upcoming Python versions. However, it deserves to mention that JorCademy is, as it stands, a non-profit organization. Therefore, updates might take some time to be released.

Credits

This template provides a number of assets for the developer to use. To express our gratitude for the creators of these assets, we provide links to the used sources below:

Contact

If you have any questions or remarks, feel free to reach out: [email protected]