Installation¶
System requirements¶
Computer and a WebCam (for some controllers) for now.
Installation of the python environment¶
The recommended installation method relies on Conda to manage your Python environments. I highly recommend using Conda for this purpose.
Download the repository¶
There are different ways to download the repository:
Using your web browser, go to the GitHub page of the project Code button and select “Download ZIP”. Save the file to your computer and then uncompress the file.
If you have git installed, open your terminal and run:
git clone https://github.com/rivelco/NeuroArcade.git
After this, use the terminal to navigate to the main directory of NeuroArcade.
Installation using pip¶
You can install NeuroArcade using pip. It’s still recommended that you do this using conda or some other environment manager. If you’re using conda type:
conda create -n neuroarcade python=3.10
conda activate neuroarcade
The above command will create a new environment called neuroarcade and with python 3.10 installed. You can choose the name of the environment replacing neuroarcade with the name you prefer. After the environment is created it must be activated.
To install neuroarcade simply run:
pip install .
Verifying the installation¶
To verify that NeuroArcade is installed correctly, run:
python -c "import neuroarcade; print(neuroarcade.__version__)"
Or alternatively:
neuroarcade --version
If the version is printed without errors, the installation was successful.
Run the arcade¶
neuroarcade
It’s also possible to launch the GUI by using:
python -m neuroarcade
Pack the arcade to an .exe file¶
Create an environment for this:
conda create -n neuroarcade_prod python=3.10
conda activate neuroarcade_prod
Install the prod version of the package:
pip install -e .[prod]
Pack the game using:
pyinstaller --onefile --windowed --name NeuroArcade --icon="src/NeuroArcade/ui/icons/NeuroArcade.ico" --paths src --collect-all mediapipe --collect-all neuroarcade --add-data "src/neuroarcade/ui;neuroarcade/ui" --add-data "src/neuroarcade/assets;neuroarcade/assets" --add-data "src/neuroarcade/sounds;neuroarcade/sounds" src/neuroarcade/main.py