Skip to content

Commit 84c7346

Browse files
docs: README updated along with ua-UA locale
2 parents c412716 + 280073f commit 84c7346

File tree

2 files changed

+36
-48
lines changed

2 files changed

+36
-48
lines changed

README.md

Lines changed: 32 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,47 @@
11
# XCoder - easy to use modding tool
22

3-
Multiplatform modding tool for ANY Supercell\`s game.
3+
A multiplatform modding tool designed for ANY Supercell game.
44

55
## About
66

7-
Work with Supercell\`s files on **any** os! SC and CSV are supported for all
8-
Supercell\`s games.
7+
Effortlessly work with Supercell\`s game files! XCoder offers support for SC and CSV
8+
formats across all Supercell games.
99

10-
### Features:
10+
### Features
1111

1212
- SC compile / decompile
1313
- Compression and decompression
1414

15-
### How to install and use
16-
17-
- On Windows:
18-
- Download Python 3.10 or newer version
19-
from [official page](https://www.python.org/downloads/)
20-
- Install Python. While Installing, enable such parameters as "Add Python to
21-
PATH", "Install pip", "Install py launcher", "Associate files with Python" and "Add Python to environment variables"
22-
- Download XCoder from the [releases page](https://github.com/xcoder-tool/XCoder/releases) and extract it
23-
- Locate the extracted directory and install required modules:
24-
```cmd
25-
poetry install
26-
```
27-
- Run program with
28-
```cmd
29-
poetry run python -m xcoder
30-
```
31-
32-
- On Linux:
33-
- Open Terminal and install Python by executing following command:
15+
### Installation and Usage
16+
17+
**Windows**:
18+
19+
1. Download Python 3.10 or newer version from
20+
the [official page](https://www.python.org/downloads/)
21+
2. Install Python. While Installing, enable such parameters as "Add Python to
22+
PATH", "Install pip", "Install py launcher", "Associate files with Python" and "Add
23+
Python to environment variables"
24+
25+
**Linux**:
26+
27+
1. Open Terminal and install Python using:
3428
```sh
3529
sudo apt-get update && sudo apt-get install python3 python3-poetry
3630
```
37-
- Download XCoder from the [releases page](https://github.com/xcoder-tool/XCoder/releases) and extract it
38-
- Locate the extracted directory and install required modules by executing following
39-
command:
31+
32+
**Common steps**:
33+
34+
1. Download XCoder from
35+
the [releases page](https://github.com/xcoder-tool/XCoder/releases) and extract it
36+
2. Go to the extracted directory and install required modules by executing:
4037
```sh
4138
poetry install
4239
```
43-
- Run program with
44-
```cmd
40+
3. Run program with
41+
```sh
4542
poetry run python -m xcoder
4643
```
4744

48-
### Testing
49-
50-
The project supports unit-testing using the unittest module. To run tests by yourself,
51-
use the command:
52-
53-
```sh
54-
poetry run python -m unittest
55-
```
56-
5745
### How to enable KTX section
5846

5947
![KTX section demo](docs/KTX%20section.png)
@@ -64,15 +52,15 @@ perform this step.**
6452
To enable the KTX module, you need to get the "PVRTexToolCLI" binary from the official
6553
site: https://developer.imaginationtech.com/pvrtextool/.
6654

67-
Then it is necessary to put CLI in "bin/" folder in the main script folder.
55+
Then it is necessary to put CLI in "bin/" folder in the main script folder or add it to
56+
your PATH environment variable.
6857

69-
### In the plans:
58+
### Planned Features
7059

71-
- CSV updating.
60+
- CSV updating
7261

7362
## Credits
7463

75-
This tool is based on Original [XCoder](https://github.com/MasterDevX/xcoder),
76-
Developer: [MasterDevX](https://github.com/MasterDevX)</br>
77-
78-
Many thanks to [spiky_Spike](https://github.com/spiky-s) for the provided developments
64+
XCoder is based on the original [XCoder](https://github.com/MasterDevX/xcoder),
65+
developed by [MasterDevX](https://github.com/MasterDevX).</br>
66+
Special thanks to [spiky_Spike](https://github.com/spiky-s) for their contributions.

xcoder/languages/ua-UA.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@
3131
"csv_label": "CSV",
3232
"decompress_csv": "Розпакувати CSV",
3333
"compress_csv": "Запакуати CSV",
34-
"decompress_csv_description": "Розпакувати файл таблиці",
35-
"compress_csv_description": "Запакувати файл таблиці",
34+
"decompress_csv_description": "Розпакувати CSV",
35+
"compress_csv_description": "Запакувати CSV",
3636

3737
"ktx_label": "KTX",
3838
"ktx_from_png_label": "PNG2KTX",
@@ -65,7 +65,7 @@
6565
"saved": "Збереження Виконано!",
6666
"illegal_size": "Неможливий розмір картинки! Очікували %sx%s але отримали %sx%s",
6767
"resize_qu": "Ти хочеш змінити розмір картинки?",
68-
"resizing": "змінюємо розмір...",
68+
"resizing": "Змінюємо розмір...",
6969
"split_pic": "Розділюємо зоображення...",
7070
"writing_pic": "Записуємо пікселі...",
7171
"compressing_with": "Запаковуємо з %s...",
@@ -90,5 +90,5 @@
9090
"enabled": "Включено",
9191
"disabled": "Виключено",
9292

93-
"install_to_unlock": "Встанови '%s' щоб розблокувати більше функції!"
93+
"install_to_unlock": "Встанови '%s' щоб розблокувати більше функцій!"
9494
}

0 commit comments

Comments
 (0)