Merge pull request #24 from Sky-CSC/GameInformation

OSL-Docfx & Docs : Update

OSL-Docfx/client/index.md

@@ -8,8 +8,8 @@
 ---
 
 ## Run application
-1. Download last release : [Release v1.1.5](https://github.com/Sky-CSC/OSL/releases/latest)
-2. Unzip ``OSL-Client-1.1.5-win-x64.zip`` to desired install folder
+1. Download last release : [Release v1.1.6](https://github.com/Sky-CSC/OSL/releases/latest)
+2. Unzip ``OSL-Client-1.1.6-win-x64.zip`` to desired install folder
 3. Change IP on ```server-socket.json```
 4. > [!CAUTION] If you understand what you are doing, add this information in this file ```C:/Riot Games/League of Legends/Config/game.cfg```
 

OSL-Docfx/web/index.md

@@ -8,8 +8,8 @@
 ---
 
 ## Run application
-1. Download last release : [Release v1.1.5](https://github.com/Sky-CSC/OSL/releases/latest)
-2. Unzip ``OSL-Web-1.1.5-win-x64.zip`` to desired install folder
+1. Download last release : [Release v1.1.6](https://github.com/Sky-CSC/OSL/releases/latest)
+2. Unzip ``OSL-Web-1.1.6-win-x64.zip`` to desired install folder
 3. Run ```OSL-Web.exe```, **Read the index web page when OSL-Web is launched**
 4. Change the Web Riot Api key in the web interface configuration
 

docs/client/index.html

@@ -100,8 +100,8 @@ <h5>Caution</h5>
 <hr>
 <h2 id="run-application">Run application</h2>
 <ol>
-<li>Download last release : <a href="https://github.com/Sky-CSC/OSL/releases/latest">Release v1.1.5</a></li>
-<li>Unzip <code>OSL-Client-1.1.5-win-x64.zip</code> to desired install folder</li>
+<li>Download last release : <a href="https://github.com/Sky-CSC/OSL/releases/latest">Release v1.1.6</a></li>
+<li>Unzip <code>OSL-Client-1.1.6-win-x64.zip</code> to desired install folder</li>
 <li>Change IP on <code>server-socket.json</code></li>
 <li>
 <blockquote>

docs/index.json

@@ -97,7 +97,7 @@
   "client/index.html": {
     "href": "client/index.html",
     "title": "Client Documentation | OSL",
-    "keywords": "Client Documentation Caution Documentation in progress Run application Download last release : Release v1.1.5 Unzip OSL-Client-1.1.5-win-x64.zip to desired install folder Change IP on server-socket.json [!CAUTION] If you understand what you are doing, add this information in this file C:/Riot Games/League of Legends/Config/game.cfg [General] EnableReplayApi=1 [Spectator] eSportsNeutralTimers=1 [LiveEvents] Enable=1 Port=34243 [!CAUTION] If you understand what you are doing, create file C:/Riot Games/League of Legends/Config/LiveEvents.ini and copy on it OnKill OnKillDragon_Spectator OnNeutralMinionKill OnMinionKill OnSummonRiftHerald OnKillWorm_Spectator OnTurretDie OnMinionKill OnChampionKill If you don't understand what you are doing download game.cfg and replace the file on C:/Riot Games/League of Legends/Config/game.cfg If you don't understand what you are doing download LiveEvents.ini and replace the file on C:/Riot Games/League of Legends/Config/LiveEvents.ini Run OSL-Web.exe , after he is running run OSL-Client.exe (make ctrl+c for close him) Configuration Configuration/riot.json : Configuration of League of Legend and riot information for operation of application \"leagueClientLiveEventsApiPort\": 34243 port used for Live Events API (Default) \"leagueClientProcess\": \"LeagueClient\" name of application (Default) \"riotLogin\": \"riot\" name of login used for LCU Api (Default) \"riotPort\": 2999 port used for Replay API (Default) Configuration/server-socket.json : Configuration of socket server for send information \"ip\": \"192.168.1.5\" Ip of server ( change it by ip of computer he run OSL-Web) \"port\": 45678 Default port, if you don't change it on OSL-Web no change this value Features Chek if riot app are launch Read lockfile Check phases (Lobby, ChampSelect, InProgress ...) Information send to the server : Champ Select (champ select of the match is in progress) In Game (spectator game is in progress) End Game (game is over) Champ Select /lol-champ-select/v1/session (LCU api) /lol-summoner/v1/summoners/ (LCU api) summoners name are write on session and sent in one go In Game /lol-gameflow/v1/session (LCU api) End Game /lol-end-of-game/v1/eog-stats-block (LCU api)"
+    "keywords": "Client Documentation Caution Documentation in progress Run application Download last release : Release v1.1.6 Unzip OSL-Client-1.1.6-win-x64.zip to desired install folder Change IP on server-socket.json [!CAUTION] If you understand what you are doing, add this information in this file C:/Riot Games/League of Legends/Config/game.cfg [General] EnableReplayApi=1 [Spectator] eSportsNeutralTimers=1 [LiveEvents] Enable=1 Port=34243 [!CAUTION] If you understand what you are doing, create file C:/Riot Games/League of Legends/Config/LiveEvents.ini and copy on it OnKill OnKillDragon_Spectator OnNeutralMinionKill OnMinionKill OnSummonRiftHerald OnKillWorm_Spectator OnTurretDie OnMinionKill OnChampionKill If you don't understand what you are doing download game.cfg and replace the file on C:/Riot Games/League of Legends/Config/game.cfg If you don't understand what you are doing download LiveEvents.ini and replace the file on C:/Riot Games/League of Legends/Config/LiveEvents.ini Run OSL-Web.exe , after he is running run OSL-Client.exe (make ctrl+c for close him) Configuration Configuration/riot.json : Configuration of League of Legend and riot information for operation of application \"leagueClientLiveEventsApiPort\": 34243 port used for Live Events API (Default) \"leagueClientProcess\": \"LeagueClient\" name of application (Default) \"riotLogin\": \"riot\" name of login used for LCU Api (Default) \"riotPort\": 2999 port used for Replay API (Default) Configuration/server-socket.json : Configuration of socket server for send information \"ip\": \"192.168.1.5\" Ip of server ( change it by ip of computer he run OSL-Web) \"port\": 45678 Default port, if you don't change it on OSL-Web no change this value Features Chek if riot app are launch Read lockfile Check phases (Lobby, ChampSelect, InProgress ...) Information send to the server : Champ Select (champ select of the match is in progress) In Game (spectator game is in progress) End Game (game is over) Champ Select /lol-champ-select/v1/session (LCU api) /lol-summoner/v1/summoners/ (LCU api) summoners name are write on session and sent in one go In Game /lol-gameflow/v1/session (LCU api) End Game /lol-end-of-game/v1/eog-stats-block (LCU api)"
   },
   "client/OSL_Client.Configuration.Config.html": {
     "href": "client/OSL_Client.Configuration.Config.html",
@@ -317,7 +317,7 @@
   "web/index.html": {
     "href": "web/index.html",
     "title": "Web Documentation | OSL",
-    "keywords": "Web Documentation Caution Documentation in progress Run application Download last release : Release v1.1.5 Unzip OSL-Web-1.1.5-win-x64.zip to desired install folder Run OSL-Web.exe , Read the index web page when OSL-Web is launched Change the Web Riot Api key in the web interface configuration Riot Developer page (take your api key) Login and copy past your \"Development API Key\" Read the index web page when OSL-Web is launched OBS configuration : Add to your différents scènes the différents URL (change ip by your local ip) Champ Select : http://ip:4141/champselect/view1 http://ip:4141/champselect/view2 http://ip:4141/champselect/view3 http://ip:4141/champselect/view4 In Game : http://ip:4141/ingame/view1 http://ip:4141/ingame/view2 http://ip:4141/ingame/view3 End Game : http://ip:4141/endgame/view1 http://ip:4141/endgame/view2 http://ip:4141/endgame/view3 Runes : http://ip:4141/runes/view1/top http://ip:4141/runes/view1/mid http://ip:4141/runes/view1/jungle http://ip:4141/runes/view1/adc http://ip:4141/runes/view1/supp http://ip:4141/runes/view1/adcsupp http://ip:4141/runes/view1/all Features, information display on pages : Feature implemented : Feature not implemented Platform Routing Values Covered (Web Riot Api) Activate Platform Host BR1 br1.api.riotgames.com EUN1 eun1.api.riotgames.com EUW1 euw1.api.riotgames.com JP1 jp1.api.riotgames.com KR kr.api.riotgames.com LA1 la1.api.riotgames.com LA2 la2.api.riotgames.com NA1 na1.api.riotgames.com OC1 oc1.api.riotgames.com TR1 tr1.api.riotgames.com RU ru.api.riotgames.com PH2 ph2.api.riotgames.com SG2 sg2.api.riotgames.com TH2 th2.api.riotgames.com TW2 tw2.api.riotgames.com VN2 vn2.api.riotgames.com . . . Regional Routing Values Covered (Web Riot Api) Activate Region Host AMERICAS americas.api.riotgames.com ASIA asia.api.riotgames.com EUROPE europe.api.riotgames.com SEA sea.api.riotgames.com . . . Language Covered (CDragon) Activate Language Key . . . Czech (Czech Republic) cs_cz/ German (Germany) de_de/ - default/ Greek (Greece) el_gr/ English (Australia) en_au/ English (United Kingdom) en_gb/ English (Philippines) en_ph/ English (Singapore) en_sg/ Spanish (Argentina) es_ar/ Spanish (Spain) es_es/ Spanish (Mexican) es_mx/ French (France) fr_fr/ Hungarian (Hungary) hu_hu/ Italian (Italy) it_it/ Japanese (Japan) ja_jp/ Korean (Korea, Republic of) ko_kr/ Polish (Poland) pl_pl/ Portuguese (Brazil) pt_br/ Romanian (Romania) ro_ro/ Russian (Russian federation) ru_ru/ Thai (Thailand) th_th/ Turkish (Turkey) tr_tr/ Vietnamese (Viet Nam) vi_vn/ Chinese (China) zh_cn/ - zh_my/ Chinese (Taiwan) zh_tw/ . . . Champ Select Link to LoL client : Champion Ban Champion Pick Summoners Name Summoners Spell (view 1) Skins Timer (ban/select/waiting) Personal information added : Name Toornament Win/Lose Team Logo Team Name Team Name Summoners Name Coach Stats Champ Ban Stats Champ Pick Stats Champ Winrate View 1 : View 2 : View 3 : View 4 : In Game With default riot overlay : Team frame Dragon frame Baron frame Name teams Number of teams victory/lose Frame for video/logo/... View 1 : View 2 : View 3 : Without riot overlay : information : Display information if the default riot overlay is disabled information : Only if reading from memory is enabled. If memory reading is enabled, the default riot overlay can be disabled. information : Data not found at this time Inter of game : LevelUp Itemps buy Dragon (Kill, next , soul) Elder Dragon (Timer, buff, all champ kill, gold diff , damege diff , next helder drake) Baron (buff, timer, all champ dead, gold diff , damage diff , next nash) Herald (buff, timer, launch or not, take or not) Kill Tower Timer Gold Gold win during fight XP + Level Damage given Damage given during fight Exter of game : Ban/Pick Runes Logo team Team name Lose/Win Video End Game Timer game Teams name Logo teams Champ dega KDA Total golds Tower Drake Elder dragon Herald Baron Ban Gold difference over time View 1 : View 2 : View 3 : Runes Summoner name Runes Top rune Jungle rune Mid rune Adc rune Support rune Adc and supp rune All lane rune View 1 Top : View 1 Mid : View 1 Jungle : View 1 Adc : View 1 Supp : View 1 Adc & Supp : View 1 All :"
+    "keywords": "Web Documentation Caution Documentation in progress Run application Download last release : Release v1.1.6 Unzip OSL-Web-1.1.6-win-x64.zip to desired install folder Run OSL-Web.exe , Read the index web page when OSL-Web is launched Change the Web Riot Api key in the web interface configuration Riot Developer page (take your api key) Login and copy past your \"Development API Key\" Read the index web page when OSL-Web is launched OBS configuration : Add to your différents scènes the différents URL (change ip by your local ip) Champ Select : http://ip:4141/champselect/view1 http://ip:4141/champselect/view2 http://ip:4141/champselect/view3 http://ip:4141/champselect/view4 In Game : http://ip:4141/ingame/view1 http://ip:4141/ingame/view2 http://ip:4141/ingame/view3 End Game : http://ip:4141/endgame/view1 http://ip:4141/endgame/view2 http://ip:4141/endgame/view3 Runes : http://ip:4141/runes/view1/top http://ip:4141/runes/view1/mid http://ip:4141/runes/view1/jungle http://ip:4141/runes/view1/adc http://ip:4141/runes/view1/supp http://ip:4141/runes/view1/adcsupp http://ip:4141/runes/view1/all Features, information display on pages : Feature implemented : Feature not implemented Platform Routing Values Covered (Web Riot Api) Activate Platform Host BR1 br1.api.riotgames.com EUN1 eun1.api.riotgames.com EUW1 euw1.api.riotgames.com JP1 jp1.api.riotgames.com KR kr.api.riotgames.com LA1 la1.api.riotgames.com LA2 la2.api.riotgames.com NA1 na1.api.riotgames.com OC1 oc1.api.riotgames.com TR1 tr1.api.riotgames.com RU ru.api.riotgames.com PH2 ph2.api.riotgames.com SG2 sg2.api.riotgames.com TH2 th2.api.riotgames.com TW2 tw2.api.riotgames.com VN2 vn2.api.riotgames.com . . . Regional Routing Values Covered (Web Riot Api) Activate Region Host AMERICAS americas.api.riotgames.com ASIA asia.api.riotgames.com EUROPE europe.api.riotgames.com SEA sea.api.riotgames.com . . . Language Covered (CDragon) Activate Language Key . . . Czech (Czech Republic) cs_cz/ German (Germany) de_de/ - default/ Greek (Greece) el_gr/ English (Australia) en_au/ English (United Kingdom) en_gb/ English (Philippines) en_ph/ English (Singapore) en_sg/ Spanish (Argentina) es_ar/ Spanish (Spain) es_es/ Spanish (Mexican) es_mx/ French (France) fr_fr/ Hungarian (Hungary) hu_hu/ Italian (Italy) it_it/ Japanese (Japan) ja_jp/ Korean (Korea, Republic of) ko_kr/ Polish (Poland) pl_pl/ Portuguese (Brazil) pt_br/ Romanian (Romania) ro_ro/ Russian (Russian federation) ru_ru/ Thai (Thailand) th_th/ Turkish (Turkey) tr_tr/ Vietnamese (Viet Nam) vi_vn/ Chinese (China) zh_cn/ - zh_my/ Chinese (Taiwan) zh_tw/ . . . Champ Select Link to LoL client : Champion Ban Champion Pick Summoners Name Summoners Spell (view 1) Skins Timer (ban/select/waiting) Personal information added : Name Toornament Win/Lose Team Logo Team Name Team Name Summoners Name Coach Stats Champ Ban Stats Champ Pick Stats Champ Winrate View 1 : View 2 : View 3 : View 4 : In Game With default riot overlay : Team frame Dragon frame Baron frame Name teams Number of teams victory/lose Frame for video/logo/... View 1 : View 2 : View 3 : Without riot overlay : information : Display information if the default riot overlay is disabled information : Only if reading from memory is enabled. If memory reading is enabled, the default riot overlay can be disabled. information : Data not found at this time Inter of game : LevelUp Itemps buy Dragon (Kill, next , soul) Elder Dragon (Timer, buff, all champ kill, gold diff , damege diff , next helder drake) Baron (buff, timer, all champ dead, gold diff , damage diff , next nash) Herald (buff, timer, launch or not, take or not) Kill Tower Timer Gold Gold win during fight XP + Level Damage given Damage given during fight Exter of game : Ban/Pick Runes Logo team Team name Lose/Win Video End Game Timer game Teams name Logo teams Champ dega KDA Total golds Tower Drake Elder dragon Herald Baron Ban Gold difference over time View 1 : View 2 : View 3 : Runes Summoner name Runes Top rune Jungle rune Mid rune Adc rune Support rune Adc and supp rune All lane rune View 1 Top : View 1 Mid : View 1 Jungle : View 1 Adc : View 1 Supp : View 1 Adc & Supp : View 1 All :"
   },
   "web/OSL_Web.Configuration.CDragon.CDragonConfig.html": {
     "href": "web/OSL_Web.Configuration.CDragon.CDragonConfig.html",

docs/web/index.html

@@ -100,8 +100,8 @@ <h5>Caution</h5>
 <hr>
 <h2 id="run-application">Run application</h2>
 <ol>
-<li>Download last release : <a href="https://github.com/Sky-CSC/OSL/releases/latest">Release v1.1.5</a></li>
-<li>Unzip <code>OSL-Web-1.1.5-win-x64.zip</code> to desired install folder</li>
+<li>Download last release : <a href="https://github.com/Sky-CSC/OSL/releases/latest">Release v1.1.6</a></li>
+<li>Unzip <code>OSL-Web-1.1.6-win-x64.zip</code> to desired install folder</li>
 <li>Run <code>OSL-Web.exe</code>, <strong>Read the index web page when OSL-Web is launched</strong></li>
 <li>Change the Web Riot Api key in the web interface configuration</li>
 </ol>