scrape/scrapeboard
scrape
/
scrapeboard
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update 'Software'

ohsqueezy 2023-05-16 18:06:59 -04:00
parent 8eae7243a2
commit ed52c6c045
1 changed files with 71 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
Software.md

@ -1,67 +1,71 @@
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.
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 and the Python imaging library (PIL). On Windows, this can be done with Powershell. On OS X, use Terminal.
python -m pip install pygame pillow
### Linux
Install pip from the package manager
sudo apt install python3-pip
Install pygame and the Python imaging library (PIL) through pip
sudo pip install pygame pillow
Scrapeboard
-----------
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/doc/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
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.
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 and the Python imaging library (PIL). On Windows, this can be done with Powershell. On OS X, use Terminal.
python -m pip install pygame pillow
### Linux
Install pip from the package manager
sudo apt install python3-pip
Install pygame and the Python imaging library (PIL) through pip
sudo pip install pygame pillow
Scrapeboard
-----------
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/doc/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
| ⬅ Previous Page | Next Page ➡ |
| -------------------------- | --------------- |
| [[Supplies and Equipment]] | [[Electronics]] |