added software page

ohsqueezy 2023-05-16 14:27:58 -04:00
parent 68471fc1fb
commit e19827bafd
1 changed files with 73 additions and 0 deletions

73
Software.md Normal file

@ -0,0 +1,73 @@
Software
========
The game currently needs to be installed from the source code, though we plan to have pre-built executables available in the future. It can be played on any operating system as long as Python and Pygame are installed.
Requirements
------------
* [Python 3.7+](https://python.org)
* [Pygame 2+](https://pygame.org)
* [Git](https://git-scm.com/)
* [Scrapeboard + PGFW code repository](https://open.shampoo.ooo/scrape/scrapeboard)
Python
------
### Windows and OS X
1. [Download the appropriate installer](https://www.python.org/downloads/) and follow the system-wide installation instructions.
2. If prompted, choose to install pip (the Python package installer) alongside Python.
### Linux
Most likely Python 3 is already installed. If not, install it from the package manager. For example, on Raspberry Pi, run
sudo apt install python3
Git
---
### Windows and OS X
Download and install from <https://git-scm.com/downloads>.
### Linux
Install from the package manager
sudo apt install git
Pygame
------
### Windows and OS X
Pip should have been installed in the first step alongside Python. If not, see [PIP getting started](https://pip.pypa.io/en/stable/getting-started/). After pip is installed, call it from the command line to install Pygame. On Windows, this can be done with Powershell. On OS X, use Terminal.
python -m pip install pygame
### Linux
Install pip from the package manager
sudo apt install python3-pip
Install pygame through pip
sudo pip install pygame
### Scrapeboard and PGFW
Use Git clone with the `--recursive` flag to download both Scrapeboard and the Pygame framework it uses from the command line (or PowerShell on Windows and Terminal on OS X). This can also be done from a Git GUI.
git clone --recursive https://open.shampoo.ooo/scrape/scrapeboard
cd scrapeboard/
### Launch
![Launch from command line](../../raw/branch/main/img/launch_from_command_line.png)
It should be possible to run in keyboard mode and test input with key presses now. The `--no-serial` flag indicates to use keyboard mode because there is no Arduino attached.
./OPEN-GAME --no-serial