Skip to content

IDE Setup

Matheus Vilano edited this page Jun 30, 2024 · 8 revisions

Current Development Specs

Hardware

No specialized hardware is required.

Software

Note: developing PyWwise on macOS or Linux is possible, but not recommended.

PyCharm Project Setup

Interpreter

It is mandatory that you use a Virtual Environment as the interpreter for this project. If you are unfamiliar with PyCharm and/or Virtual Environments, follow these steps. When creating the interpreter, make sure its name is "Python 3 (PyWwise)"; otherwise, you will see unintended changes in your repo. After creating your new Virtual Environment, you must install all dependencies in order for PyWwise modules to function correctly.

Dependencies

PyWwise relies on some modules which are not built into Python 3; you must install all dependencies (3rd-party packages) into your Virtual Environment. There are a few ways to go about installing dependencies; it is recommended that you pick one of these methods:

Code Style Settings

Code Style settings are project-specific and shared via Git and must be used by all collaborators - they should be automatically active once you open the PyWwise project with PyCharm. If you would like to double-check, open your Settings and navigate to File | Settings | Editor | Code Style | Python; the property Scheme should say "Project". Important note: changes to Code Style settings are not usually allowed - so if you see any while staging your changes, discard them.

Recommended Plugins

Sidebar test

Clone this wiki locally