1.0.1 • Published 6 months ago

open-overlay v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
6 months ago

OpenOverlay

This document proposes application that is a desktop (or potentially web) application that is a companion to the popular video game League of Legends. League of Legends is a complicated game that relies heavily on knowledge of its mechanics as a form of skill expression, thus many applications exist as supplements to provide information to players. However, many of these apps are monetized by showing ads or potentially by selling user data. Thus, I intend to create an open source program that provides a visual user interface that aids player decision making at the start of the game by relying on data provided by Riot Games through public APIs.

TODO: add screenshot of running project here

This is a screenshot.

Initial Project Proposal:

https://github.com/cis3296f23/projectfeedbackboards-section-001-m-w-11am/issues/9

How to run

Provide here instructions on how to use your application.

  • Download the latest binary from the Release section on the right on GitHub.
  • On the command line uncompress using
tar -xzf  
  • On the command line run with
./hello
  • You will see Hello World! on your terminal.

How to contribute

Follow this project board to know the latest status of the project: https://github.com/orgs/cis3296f23/projects/119/views/1

How to build

  • Use this github repository: ...
  • Specify what branch to use for a more stable release or for cutting edge development.
  • Use InteliJ 11
  • Specify additional library to download if needed
  • What file and target to compile and run.
  • What is expected to happen when the app start.