diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..27f8894 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +interaction@rcv.gg. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..765b340 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Riot Community Volunteers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 7a14dd0..d8bfee9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,65 @@ -# league-observer-tool-codebase +# league-observer-tool +The observer tool is part of our [lol-prod-toolkit](https://github.com/RCVolus/league-prod-toolkit). +The tool is used to query local client APIs (LCU, ingame) and send the data to a local or remote instance of prod-toolkit. +Once install, the observer tool automatically updates to any new versions released. -The source code for the league observer tool, part of the [prod-toolkit](https://github.com/RCVolus/league-prod-toolkit]) +## Installation +1. Download the latest release [here](https://github.com/RCVolus/league-observer-tool/releases/latest) +2. Install and run the observer tool +3. Configure the toolkit instance: +* Open the settings file by selecting File -> Open Settings +* Configure the appropriate IP (`"server-ip": "127.0.0.1"` for locally hosted toolkit) +* Before saving, close the Observer Tool either from the tray or with File -> Quit +* Save the changed config file -For docs, support and downloadable releases, please go to this repository: https://github.com/RCVolus/league-observer-tool +The config file might look like this for a local toolkit without authentication: +```json +{ + "server-ip": "127.0.0.1", + "server-port": 3003, + "server-api-key": "", + "replay-sync-mode": "get", + "live-events-port": 34243 +} +``` +If you have authentication enabled, set a key (`RCVPT-...`) in `server-api-key`. If the toolkit isn't running locally, set the toolkit IP in `server-ip`. -To contribute, please grab an issue in the main repository and/or open a pull request here. +## A Note on Memory Reading +Since version 5.0.0, the Observer tool implements passive memory reading based on [Farsight](https://github.com/floh22/native-farsight-module). Riot has previously stated passive memory reading is allowed, although this policy might change at any time without warning. Currently, memory reading while spectating should not cause you issues. Make sure you turn off the observer tool when playing games. Use at your own risk. + +Since memory offsets change with every patch and need to be updated, memory reading will not work immediately after game updates. Farsight has a [guide](https://github.com/floh22/native-farsight-module) on updating offsets yourself. + +## Setting up Replay API +For time controls, the Replay API is used (similar to what LeagueDirector does) and needs to be configured locally: +In `game.cfg` (located in `[install path]\Riot Games\League of Legends\Config`), add this value under `[General]`: +```ini +EnableReplayApi=1 +``` +If there is already a value present, make sure its set to 1; if not just add it to the bottom of the list under `[General]` + +## Setting up LiveEvents API +For ingame Events (e.g., Dragon or Baron kills), the LiveEvents API needs to be configured locally: +1. Add the following to `game.cfg` (located in `[install path]\Riot Games\League of Legends\Config`): +```ini +[LiveEvents] +Enable=1 +Port=34243 +``` +Make sure the port is the same as configured in the observer tool settings under `live-events-port`. + +2. Create a file called `LiveEvents.ini` in the same config directory +3. Paste the following in the `LiveEvents.ini` file: +```ini +OnKillDragon_Spectator +OnKillRiftHerald_Spectator +OnKillWorm_Spectator +OnTurretPlateDestroyed +OnDragonSoulGiven +``` + +## Usage +The power button at the bottom connects to the configured toolkit instance. +To connect to local League Client APIs, click Sync on the modules you need. The League Client needs to be running. + +## Legal Disclaimer +league-prod-toolkit was created under Riot Games' "Legal Jibber Jabber" policy using assets owned by Riot Games. Riot Games does not endorse or sponsor this project. \ No newline at end of file