Skip to content

Commit daf0fc3

Browse files
committed
readme second draft
1 parent 288d259 commit daf0fc3

1 file changed

Lines changed: 28 additions & 16 deletions

File tree

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,44 @@
11
# Python Discord Code Jam 2025: Cool Cacti
22

3-
## overview
4-
We created pygame-like functionality using pyodide. Using a context object, we are able to replicate JavaScript like functionality in python. See https://developer.mozilla.org/en-US/docs/Web/API for what methods ctx has.
5-
6-
## purpose
7-
Many aspiring python developers use pygame to improve their skills. However, it isn't so easy sharing their game with their less technical friends or family. They could use something like PyInstaller, but that requires people to trust executables (I don't really like this section tbh)
3+
## Overview
4+
We created pygame-like functionality using pyodide. Using a context object, we are able to replicate javascript-like functionality in Python. See https://developer.mozilla.org/en-US/docs/Web/API for what methods ctx has. The game itself is presented in the video.
5+
6+
"Building Blocks" we implemented for our game:
7+
- Drawing shapes (eclipses, rectangles, etc)
8+
- Audio
9+
- Sprites/Spritesheets
10+
## Approved frameworks
11+
We used pyodide
12+
(Soosh, please fill this part out)
13+
(add some extra description as to how developing with pyodide made it harder)
14+
Suggestions:
15+
Extra files (html, css, extra py files that would otherwise not be needed if not for pyodide)
16+
Working with ctx (no autocomplete, docs are in JavaScript and not Py)
17+
We need to hit this criteria here: "Which approved library/framework was used and how it was used"
818

919
## Theme
1020
We achieved connection to the theme in 2 ways:
1121
### Pyodide
12-
Pyodide is inherently the wrong tool for the job, since libraries such as Pygbag exist. (Guys, add some extra description as to how developing with Pyodide made it harder)
13-
Suggestions:
14-
Extra files (html, css, extra py files that would otherwise not be needed if not for Pyodide)
15-
Working with ctx (no autocomplete, docs are in JavaScript and not Py)
22+
Pyodide is inherently the wrong tool for the job, since libraries such as pygbag exist, or you could package your pygame with something like PyInstaller.
23+
1624
### The game
17-
(Spoilers!) The introduction depicts aliens flying around space past the speed of light, about to turn on their super advanced intergalatic planet scanner. Today, it fails. Luckily, one of the aliens has a barcode scanner from his work, but they need to go orbit planets for some time to scan, rather than fly faster than light. Our game and its mechanics are centered around this barcode scanner that they must use. It's the "wrong tool for the job", since you really shouldn't be scanning planets with a supermarket barcode scanner. (Still works though, they are very advanced aliens!)
25+
(Spoilers!) The introduction depicts aliens flying around space past the speed of light, about to turn on their super advanced intergalactic planet scanner. Today, it fails. Luckily, one of the aliens has a barcode scanner from his work, but they need to go orbit planets for some time to scan, rather than fly faster than light. Our game and its mechanics are centered around this barcode scanner that they must use. It's the "wrong tool for the job", since you really shouldn't be scanning planets with a supermarket barcode scanner. (Still works though, they are very advanced aliens!)
1826

1927
## Individual contributions
28+
(Add your contributions here)
29+
2030
RealisticTurtle: Intro scene, Game scene, story, stars, scanning mechanics
2131

22-
Soosh: Libary research, Pyodide setup, colored stars
32+
Soosh: Library research, pyodide setup, colored stars
2333

24-
Dark Zero: main scene, sprites, player mechanics, asteroids, end scene
34+
Dark Zero: main scene, sprites, player mechanics, asteroid logic, end scene
2535

26-
Doomy: Text boxes, endscreen, experimented with Marimo
36+
Doomy: Text boxes, end scene, experimented with marimo
2737

28-
## installation and usage
38+
## Installation and usage
2939
Uhh idk theres no reqs.txt
3040

31-
## Gameplay:
32-
View the video at: https://youtube.com/placeholder
41+
## The game:
42+
View the video at: https://youtube.com/placeholder
43+
44+
The video will display the game and its mechanics.

0 commit comments

Comments
 (0)