Developer Setup

Windows

1. Install Python 3.10 (newer versions are not compatible)
2. Clone/download this repository
3. Open the project folder in your editor/IDE
   1. (NOTE) It is highly recommended that you use Visual Studio Code. Some IDEs (like Pycharm) are known to have import pathing issues with this project.
4. Open the repository folder in a terminal window
   1. (NOTE) If you downloaded OSBC as a .zip file, be aware there may be a duplicate container folder
   2. Create a virtual environment py -3.10 -m venv env
   3. Activate the newly created virtual environment .\env\Scripts\activate
   4. Install the dependencies pip install -r requirements.txt
5. Run ./src/OSBC.py *(may need to restart IDE for it to recognize installed dependencies)

Linux

Please only use Linux if you know what you're doing. OSBC has only been tested in Ubuntu v22.04.

1. Make sure your GNOME display server is running Xorg, not Wayland. See here for instructions. If you don't see the option to switch to Xorg on the Ubuntu login page, try the following:
   1. Run sudo apt-get install xorg-dev
   2. Open a file called /etc/gdm3/custom.conf
      1. Uncomment the line #WaylandEnable=false
      2. Save the file and run sudo systemctl restart gdm3
2. Set up RuneLite:
   1. Download the AppImage file from RuneLite.net
   2. Install FUSE sudo apt install fuse
   3. Modify the permissions of the file chmod 764 <path-tofile>/RuneLite.AppImage
3. Run the following commands:
   1. sudo apt update
   2. sudo apt install build-essential
   3. sudo apt install python3-dev (ensure Python 3.10 is installed)
   4. sudo apt install python3-tk
4. Clone the repository and navigate to the project folder in your terminal. Run the following commands:
   1. Create a virtual environment python3 -m venv env
   2. Activate the virtual environment . env/bin/activate
   3. Install the dependencies pip install -r requirements.txt
5. Run ./src/OSBC.py
   1. If you're getting errors involving mss, retry step 1.

Note:

OSBC currently does not work well with scaled-resolution screens. Please set your resolution scaling to 100% in your operating system settings.