Skip to content

README.md

Latest commit

 

History

History
110 lines (85 loc) · 4.31 KB

README.md

File metadata and controls

110 lines (85 loc) · 4.31 KB
Raw

PyDew Valley

PyDew Valley is a project originally created by ClearCode in Python using pygame-ce.

This expanded version will be used by the University of Zurich's Department of Psychology in an experimental study in social psychology.

This particular repository covers the versions of the game used for the second part of the study.

For more information, please contact s.kittelberger[at]psychologie.uzh.ch.

Setup Instructions

This project requires Python 3.12. (Python 3.13 may cause issues, and free-threaded Python is not supported.)
PyPy is also unsupported.

  1. Clone this repository:

    git clone https://github.com/sloukit/pydew-valley-uzh-second-study.git

  2. Create and activate a virtual environment:

    Linux/MacOS

    python3 -m venv venv
source venv/bin/activate

    For Windows

    python -m venv venv
venv\Scripts\activate

  3. Install dependencies

    pip install -r requirements.txt # For running the game (runtime dependencies)
pip install -r requirements-dev.txt # For local development
pip install -r requirements-test.txt # For running tests

  4. Run this project

    python main.py

Local Development

See CONTRIBUTING.md for more information on how contributions can be made.

Linting and Formatting

We use Ruff for linting and formatting. Run pip install -r requirements-dev.txt to install it and other relevant dependencies.

Important

Before opening a PR, please run the following command to ensure that your code is formatted and doesn't upset the Ruff linter:

python formatlint.py

Or alternatively, run the following commands individually:

ruff format . && ruff check --select I --fix . #  format code and sort imports
ruff check . # Run linting and perform fixes accordingly, or use '# noqa: <RULE>' followed by a comment justifying why the rule is ignored

Use of AI

We do not use AI for visual and design tasks.

Contributing

Please check CONTRIBUTING.md for more information.

Team

This section is continuously updated.

Relevant Links