tomp2 / ot-harjoitustyo

CS course project + exercises

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Skilltracker

ot-harjoitustyö (this is a university software development course practise project)

This software allows the user to track their performance in an online shooter game recoil control. In many online shooter games, the user can try to counteract the recoil by moving their mouse in a specific way.

Table of Contents
  1. Downloads
  2. Installation
  3. Documentation

Downloads

Latest release available here!

Installation

Method 1: For end user using pipx:

  1. Install pipx. Pipx installs Python apps to nice isolated environments.
  2. Install straight from GitHub using pipx
    pipx install git+https://github.com/tomp2/ot-harjoitustyo.git
  3. Start the application from the command line
    skilltracker

Method 2: For end user using pip

  1. Create a virtual environment (optional but very recommended!)

    python -m venv venv
  2. Activate the virtual environment (if using one)

    Platform Command
    POSIX/bash source venv/bin/activate
    Windows/PowerShell venv\Scripts\Activate.ps1
  3. Install from GitHub using pip

    pip install git+https://github.com/tomp2/ot-harjoitustyo.git
  4. Start the application from the command line

    python -m skilltracker

    The virtual environment must be activated to launch with the above command. Activate the venv when using the app again later.

Method 3: For development and testing using poetry

  1. Install poetry
  2. Clone the repository
    git clone https://github.com/tomp2/ot-harjoitustyo
  3. Navigate into the directory
    cd ot-harjoitustyo
  4. Install dependencies
    poetry install
  5. Start the application
    poetry run invoke start

Oneliner:

git clone https://github.com/tomp2/ot-harjoitustyo &&
  cd ot-harjoitustyo && poetry install && poetry run invoke start

Documentation

About

CS course project + exercises


Languages

Language:Python 100.0%