Skip to content

How to develop a2

Eric Werner edited this page Nov 11, 2020 · 4 revisions

WIP! see #2, #127, #151

Overview

There is multiple parts to this! Developing for a2 can mean any of these things:

  • develop a2 ui
    • build/use widgets
    • create elements
  • create modules
    • host module packages
    • create module elements

have a github account

a2testuser42

get the project

a2 is written in Python 3 and Autohotkey. I'll cover how to get a special IDE and how to set up at a later point. For now that should be up to you which Python IDE you use. Just make sure you have the following:

Init:

Clone/Fork the repo and install dependencies: https://help.github.com/articles/fork-a-repo

  • With GitHub for Windows installed:

Click the Clone or download button on the a2 github homepage and then Open in Desktop.

  • or git commandline:
git clone https://github.com/ewerybody/a2.git --recursive

Python Requirements:

On the commandline in your Python3/Scripts folder:

pip install PySide2

If you want to make packages. You also need:

pip install PyInstaller

If you have multiple Python versions installed and the 3.6 one is not available through the PATH environment variable:
make sure to add the path to the python.exe file into the settings\a2_settings.ahk file

(The req.txt files have been removed because it seemed impossible to make the tech preview of PySide2 available like this.)

Editing tools

Python Framework

We recommend VS Code

  1. Download VS Code
  2. Install the Python package

AutoHotKey scripts

Any kind of text editor will do, yet we recommend in descending order:

  • VS Code is also good for AHK!
  • find an AutoHotkey extension inside.