Files
oe-html-viewer/README.md
2025-04-02 15:24:33 +02:00

82 lines
3.1 KiB
Markdown

# SportSoftware OE HTML megjelenítő
[![en](https://img.shields.io/badge/lang-en-blue.svg)](https://gitea.carburator.dev/carburator/oe-html-viewer/src/branch/main/README.en.md)
Egyszerű python program, amivel a tájfutó eseményeken használt OE11 és OE12 programból exportált HTML fájlokat lehet megjeleníteni kijelzőn, vagy a helyi hálózaton.
## Funkciók
<ul style="list-style-type: none"> ✅ Személyre szabható automatikus görgetés </ul>
<ul style="list-style-type: none"> ✅ Finom görgetés </ul>
<ul style="list-style-type: none"> ✅ Automatikus újratöltés a lap alján </ul>
<ul style="list-style-type: none"> ✅ Automatikus újratöltés, ha nincs szükség görgetésre </ul>
<ul style="list-style-type: none"> ✅ Támogatja az OE11 és OE12-ből exportált HTML fájlokat is </ul>
<ul style="list-style-type: none"> ✅ Megjeleníti a fájlt localhost-on és a helyi hálózaton is </ul>
### Változók
A `main.py` fájl elején található, szerkeszthető változók:
- `html_file_path`: Elérési út a HTML fájlhoz. Példa: `C:\Users\<felhasználó>\Documents\példa-verseny\eredmenyek.html`
- `host`: A webszerver IP címe. Hagyd az alapértelmezett `0.0.0.0` értéken, hogy elérhető legyen a fájl lokálisan és a lokális hálózaton is
- `port`: A webszerver portja. Alapértelmezetten `80`, ez elhagyható az URL-ből
- `is_oe11`: Változó az OE11 vagy OE12 kiválasztására. Legyen `True` ha OE11-et használsz és `False`, ha OE12-t
- `scroll_pixels`: Ennyi pixelt görget lefelé
- `scroll_interval`: Időtartam másodpercben, ennyi időnként görget
- `bottom_wait_time`: Időtartam másodpercben, ennyit vár ha a lap aljára ért újratöltés előtt
- `top_wait_time`: Időtartam másodpercben, ennyit vár a lap tetején, mielőtt elkezdődne a görgetés
- `reload_interval`: Időtartam másodpercben, ennyit vár újratöltés előtt, ha nincs szükség görgetésre, mert a tartalom kifér a képernyőre. Legyen ez az érték minimum 1 másodperccel több, mint az automatikus exportálás ideje az OE-ben.
## Használat
### Előfeltételek
- Python 3.x
- pip
- virtualenv
### Telepítés
A következő parancsokat CMD-ben vagy PowerShell-ben kell kiadni.
1. Töltsd le a repository-t:
```sh
git clone https://gitea.carburator.dev/carburator/oe-html-viewer.git
cd oe-html-viewer
```
2. Hozz létre egy virtuális környezetet:
```sh
python -m venv .venv
```
3. Aktiváld a virtuális környezetet:
```sh
.venv\Scripts\activate
```
4. Telepítsd a szükséges csomagokat:
```sh
pip install -r requirements.txt
```
### Futtatás
0. Ha már telepítetted és újra használni akarod, akkor előbb aktiváld a virtuális környezetet. Lásd: Telepítés - 3.
1. Indítsd el a programot:
```sh
python main.py
```
2. Nyisd meg a böngészőt és írd be a címsorba: `http://localhost`. Más eszközről a helyi hálózaton: `http://<host gép ip címe>`
### Licensz
Ez a projekt az MIT Licensz alatt van licenszelve - részletekért lásd a LICENSE fájlt.
<hr>
<p style="text-align: center;"> Készült sok ❤️-el a 603 NYÍRSÉG IC-n </p>