PaPiRus-boardGames

This project is aimed at bringing board games to the PaPiRus zero screen for the raspberry pi

To run the program simple run the script main.py, change line 5 "import screenTester as scr" to "import screen as scr" if your running on the PI with the screen.

For a detailed explination on making a game see the wiki

Making games with library

Import the file "screenTester" or "screen" (for executing on the PI) Commands:

button( index ) -- Is button down? Returns a bool

update() -- Updates the screen to the changes you made

updateFull() -- Updates the screen fully, this is slow but clears the screen from all gunky stuff

clear() -- Clears the screen from all objects (doesen't update after)

rectangle(first_x, first_y, end_x, end_y, fill) -- Draws a rectangle at (first_x,first_y) to the point (end_x,eny_y). Fill is if you want the rectangle to be filled or not

circle(pos_x, pos_y, radius, fill) -- Draws a circle with the center (pos_x,posy) and the radius . Im pretty sure you know what fill means so i won't keep explainng it!

line(first_x,first_y,end_x,end_y) -- Draws a line from (first_x,first_y) to the point (end_x,end_y)

text(pos_x,pos_y,text) -- Draws text at the position (pos_x,pos_y) with the text

image(pos_x,pos_y,path) -- Draws a image at the position (pos_x,pos_y) and drawing the image from the path

Using the library

In your program you should try to use a while loop and call the function updateLoop as much as you can since this deals with events and if you are testing with the tester script it will update the tkinter window so it doesen't freeze, and with the normal script it will do button events

If you find it annoying programming buttons you can bind a function to be called when a button is pressed or let go, simply change the list 'downBind' or 'upBind' to bind a function to each button. e.g.

downBind[0] = sayHello() -- Bind the button at the very left to call the function as soon as it is pressed

upBind[4] = shutdown() -- Bind the button at the very right to call the function as soon as the button is let go

All of the functions and variables mentioned will be in the library screenTester and screen when imported.

Making a game

Games made must be a python script in the "games" directory followed by its icon screen which should be EXACTLY the same name as the script (apart from the extention) with the extention .png in the "gameIcons" directory. The image has to be the size 200x42

When you have put the two files in, inside your game you need to make a class called "Main". Inside your new class put an init function inside and two paramiters will be required, the first is a pointer to the screen library thing mentioned on how to use obove, the second is a pointer to a function that when called, exits the game back to the main screen.

In your class you need to have a function named "loop", no paramiters. This will be called in a while loop to run the game. Example:

class Main():

def __init__(self,game,exitGame):

	self.scr = game
	
	game.downBind[2] = exitGame #When button 3 is pressed it will exit the game
	
	self.render()

def render(self):
	
	self.scr.clear()
	
	self.scr.text(0,0,"An example program")
	
	self.scr.update()

def loop(self):
	
	pass