1
1
# XCoder - easy to use modding tool
2
2
3
- Multiplatform modding tool for ANY Supercell\` s game.
3
+ A multiplatform modding tool designed for ANY Supercell game.
4
4
5
5
## About
6
6
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.
9
9
10
- ### Features:
10
+ ### Features
11
11
12
12
- SC compile / decompile
13
13
- Compression and decompression
14
14
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:
34
28
``` sh
35
29
sudo apt-get update && sudo apt-get install python3 python3-poetry
36
30
```
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:
40
37
` ` ` sh
41
38
poetry install
42
39
` ` `
43
- - Run program with
44
- ```cmd
40
+ 3. Run program with
41
+ ` ` ` sh
45
42
poetry run python -m xcoder
46
43
` ` `
47
44
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
-
57
45
# ## How to enable KTX section
58
46
59
47
! [KTX section demo](docs/KTX%20section.png)
@@ -64,15 +52,15 @@ perform this step.**
64
52
To enable the KTX module, you need to get the " PVRTexToolCLI" binary from the official
65
53
site: https://developer.imaginationtech.com/pvrtextool/.
66
54
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.
68
57
69
- ### In the plans:
58
+ # ## Planned Features
70
59
71
- - CSV updating.
60
+ - CSV updating
72
61
73
62
# # Credits
74
63
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.
0 commit comments