-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
50 additions
and
2 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,45 @@ | ||
# [pyckitup](https://pickitup247.com/pyckitup.html) | ||
|
||
![logo](https://pickitup247.com/pyckitup/logos/facebook_cover_photo_2.png) | ||
|
||
## About | ||
|
||
Hi there! pyckitup is a Python game engine you can use to make 2D games. It is free, open source and works on Web, Linux, OS X and Windows. | ||
|
||
|
||
## Getting Started | ||
|
||
|
||
1. Download pyckitup binary. | ||
|
||
* Linux: [download](https://github.com/pickitup247/pyckitup/releases/tag/0.1) | ||
|
||
* Windows: [build instructions](./pyckitup/contribute.md) | ||
|
||
* OS X: [build instructions](./pyckitup/contribute.md) | ||
|
||
2. Initialize game folder | ||
|
||
The folder contains the clock example game. | ||
|
||
```bash | ||
pyckitup init hello | ||
cd hello | ||
pyckitup | ||
``` | ||
|
||
3. Iterate over your game | ||
|
||
4. Once ready, deploy to web with | ||
|
||
```bash | ||
pyckitup build | ||
``` | ||
|
||
This creates a `build/` directory which contains everything you need to deploy your awesome game to the web. Simply copy the folder to where you want it served. | ||
|
||
## How it works | ||
|
||
pyckitup is a thin layer glueing RustPython interpreter to quicksilver game engine. It compiles to a single binary on different systems. Native binaries(as opposed to wasm) also come with wasm files. | ||
|
||
When you load a pyckitup game in browser, it loads a single 5MB wasm blob and interprets Python code stored in localStorage. As a result there is a 10MB code size limit. |