📝 | Edited README.md.
This commit is contained in:
parent
a6ec406220
commit
946dac5e8d
104
README.md
104
README.md
@ -1,34 +1,25 @@
|
||||
**FinnWarsLauncher**
|
||||
==================
|
||||
|
||||
====
|
||||
## Less fiddling, more battling
|
||||
|
||||
|
||||
Table of Contents
|
||||
-----------------
|
||||
[EN]
|
||||
FinnWarsLauncher is a graphical user interface (GUI) application designed to launch the FinnWars game with custom server address and username settings.
|
||||
|
||||
[FI]
|
||||
FinnWarsLauncher on käyttöliittymäapplikaatio suunniteltu käynnistämään FinnWars-modilla varustettu Battlefield 1942 peli ja liittymään annetulle palvelimelle halutulla käyttäjänimellä.
|
||||
|
||||
1. [Introduction](#introduction)
|
||||
2. [Requirements](#requirements)
|
||||
3. [Installation](#installation)
|
||||
4. [Usage](#usage)
|
||||
5. [Troubleshooting](#troubleshooting)
|
||||
6. [Contributing](#contributing)
|
||||
|
||||
### GOOD TO KNOW / Hyvä tietää
|
||||
----
|
||||
[EN]
|
||||
#### FinnWarsLauncher is an EXPERIMENTAL LAUNCHER and does NOT work properly on all systems, so be patient if your faced problem doesn't get resolved immediately!!!
|
||||
|
||||
[FI]
|
||||
#### FinnWarsLauncher on KOKEELLINEN OHJELMA ja se EI toimi oikein kaikilla järjestelmillä, joten ota rennosti jos löytämääsi ongelmaa ei korjata silmänräpäyksessä!!!
|
||||
|
||||
|
||||
### Introduction / Esittely
|
||||
[EN]
|
||||
FinnWarsLauncher is a graphical user interface (GUI) application designed to launch the FinnWars game with custom server address and username settings.
|
||||
|
||||
[FI]
|
||||
FinnWarsLauncher on käyttöliittymäaplikaatio suunniteltu käynnistämään FinnWars-modilla varustettu Battlefield 1942 peli ja liittymään annetulle palvelimelle halutulla käyttäjänimellä-
|
||||
|
||||
### Requirements / Vaatimukset
|
||||
----
|
||||
* Python 3.12.x or newer
|
||||
* TKinter installed via distributions package manager (Linux things...)
|
||||
Some Linux distributions require installing tkinter/tk via package manager.
|
||||
@ -42,42 +33,83 @@ FinnWarsLauncher on käyttöliittymäaplikaatio suunniteltu käynnistämään Fi
|
||||
```
|
||||
aaand others you probably can figure out yourself :)
|
||||
|
||||
### Installation from source / Asennus lähdekoodista
|
||||
|
||||
### Installation from source / Asennus lähdekoodista
|
||||
----
|
||||
[EN]
|
||||
Some distributions use `python3` instead of `python` so keep that in mind!
|
||||
0. ^ Install requirements ^
|
||||
1. Clone repository:
|
||||
```
|
||||
git clone https://git.huitsinnevada.fi/NikkeDoy/FinnWarsLauncher.git
|
||||
```
|
||||
2. Install packages (preferably to fresh virtual environment)
|
||||
2. Create virtual environment (Optional / Recommended)
|
||||
```
|
||||
# Create virtual environment named `venv`
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
# Install packages
|
||||
```
|
||||
3. Install packages
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
3. Run the application with:
|
||||
|
||||
[EN]
|
||||
Useat järjestelmät käyttävät `python3`-komentoa `python` sijaan, joten pidä se mielessä!
|
||||
0. ^ Asenna vaatimukset ^
|
||||
1. Kloonaa repositorio:
|
||||
```
|
||||
git clone https://git.huitsinnevada.fi/NikkeDoy/FinnWarsLauncher.git
|
||||
```
|
||||
2. Luo virtual environmentti (Ei pakollinen / Suositeltu)
|
||||
```
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
3. Asenna paketit
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
|
||||
### Usage / Käyttö
|
||||
----
|
||||
[EN]
|
||||
0. Be sure that you are currently using created virtual environment (if you don't create it then no worries.)
|
||||
1. Run the application with:
|
||||
```
|
||||
python main.py
|
||||
```
|
||||
2. Change settings.
|
||||
3. Save settings by clicking `Save`-button.
|
||||
4. Launch the game by pressing `Launch`-button and give them HELL.
|
||||
|
||||
### Usage
|
||||
[FI]
|
||||
0. Varmista, että käytät juuri luotua virtual environmentia (jos olet sen luonut)
|
||||
1. Käynnistä applikaatio komennolla:
|
||||
```
|
||||
python main.py
|
||||
```
|
||||
2. Vaihda asetuksia...
|
||||
3. Tallenna asetukset painamalla `Save`-näppäintä.
|
||||
4. Pelaa painamalla `Launch`-näppäintä ja anna vihuille KYYTIÄ.
|
||||
|
||||
1. Launch the application by running `python finnwarlauncher.py`
|
||||
2. Enter a valid server address in the "Server Address" field (e.g., `23.88.63.235:14572`)
|
||||
3. Enter a username in the "Username" field (max 16 characters)
|
||||
4. Click the "Save" button to save your preferences for future launches
|
||||
5. Click the "Launch" button to launch the FinnWars game with your custom settings
|
||||
|
||||
### Troubleshooting
|
||||
### Troubleshooting / Vianetsintä
|
||||
----
|
||||
[EN]
|
||||
* TODO
|
||||
* If it doesn't work then... shit... create an issue by following our "ISSUE GUIDELINES."
|
||||
|
||||
* If you encounter issues with launching the game, ensure that the `bottles-cli` command-line tool is installed and configured correctly on your
|
||||
system.
|
||||
* If you experience problems with saving preferences, check that the userdata module is functioning correctly.
|
||||
[FI]
|
||||
* TODO
|
||||
* Jos applikaatio ei toimi, niin... luo uusi issue noudattamalla meidän "ISSUE OHJEITA."
|
||||
|
||||
### Contributing
|
||||
### Contributing / Kontribuoi
|
||||
----
|
||||
[EN]
|
||||
Contributions to this project are welcome!
|
||||
Please submit your pull request or issue to this repository.
|
||||
|
||||
Contributions to this project are welcome! Please submit pull requests or issues on the GitHub repository.
|
||||
[FI]
|
||||
Apu kelpaa aina!
|
||||
Laita vain tulemaan pull requestit tai issuet tähän repoon.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user