|
1 |
| -# XCoder - easy to use modding tool |
2 |
| -Multiplatform modding tool for ANY Supercell\`s game. |
| 1 | +# XCoder: The Easy Modding Tool |
| 2 | + |
| 3 | +A multiplatform modding tool designed for ANY Supercell game. |
3 | 4 |
|
4 | 5 | ## About
|
5 |
| -Work with Supercell\`s files on **any** os! SC and CSV are supported for all Supercell\`s games. |
6 |
| - |
7 |
| -### Features: |
8 |
| -- SC compile / decompile; |
9 |
| -- Compression and decompression. |
10 |
| - |
11 |
| -### How to install and use |
12 |
| -- On Windows: |
13 |
| - - Download Python 3.7 or newer version from [official page](https://www.python.org/downloads/); |
14 |
| - - Install Python. While Installing, enable such parameters as "Add Python to PATH", "Install pip", "Install py launcher", "Associate files with Python" and "Add Python to environment variables"; |
15 |
| - - Download XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it; |
16 |
| - - Locate the extracted directory and install required modules: |
17 |
| - ```pip install -r requirements.txt```; |
18 |
| - - Execute "main.py" file. |
19 |
| - |
20 |
| -- On Linux: |
21 |
| - - Open Terminal and install Python by executing following command: |
22 |
| - ```sudo apt-get update && sudo apt-get install python3 python3-pip```; |
23 |
| - - Download XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it; |
24 |
| - - Locate the extracted directory and install required modules by executing following command: |
25 |
| - ```sudo pip3 install -r requirements.txt```; |
26 |
| - - Execute "main.py" file. |
27 |
| - |
28 |
| -- On Android: |
29 |
| - - Download and install PyDroid app from [Google Play](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3); |
30 |
| - - Open PyDroid and wait until Python installs; |
31 |
| - - Download XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it; |
32 |
| - - Install loguru using pip; |
33 |
| - - In PyDroid open and execute "main.py" file. |
34 |
| - |
35 |
| -### In the plans: |
36 |
| -- CSV updating. |
| 6 | + |
| 7 | +Effortlessly work with Supercell's game files on **any** operating system! XCoder offers support for SC and CSV formats across all Supercell games. |
| 8 | + |
| 9 | +### Features |
| 10 | + |
| 11 | +- SC compile / decompile |
| 12 | +- Compression and decompression |
| 13 | + |
| 14 | +### Installation and Usage |
| 15 | + |
| 16 | +**Windows:** |
| 17 | + |
| 18 | +1. Download Python 3.7 or a newer version from the [official page](https://www.python.org/downloads/). |
| 19 | +2. During installation, select options like "Add Python to PATH," "Install pip," "Install py launcher," "Associate files with Python," and "Add Python to environment variables." |
| 20 | +3. Download XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract the files. |
| 21 | +4. Go to the extracted directory and install required modules by executing: `pip install -r requirements.txt` |
| 22 | +5. Run the "main.py" file. |
| 23 | + |
| 24 | +**Linux:** |
| 25 | + |
| 26 | +1. Open Terminal and install Python using: `sudo apt-get update && sudo apt-get install python3 python3-pip` |
| 27 | +2. Download XCoder from the [releases page](https://github.com/xcoder-tool/XCoder/releases) and extract the files. |
| 28 | +3. Navigate to the extracted directory and install necessary modules by executing: `sudo pip3 install -r requirements.txt` |
| 29 | +4. Run the "main.py" file. |
| 30 | + |
| 31 | +**Android:** |
| 32 | + |
| 33 | +1. Download and install the PyDroid app from [Google Play](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3). |
| 34 | +2. Open PyDroid and wait for Python installation. |
| 35 | +3. Get XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract the files. |
| 36 | +4. Install loguru using pip. |
| 37 | +5. In PyDroid, open and execute the "main.py" file. |
| 38 | + |
| 39 | +### Upcoming Features |
| 40 | + |
| 41 | +- CSV updating |
37 | 42 |
|
38 | 43 | ## Credits
|
39 |
| -This tool is based on Original [XCoder](https://github.com/MasterDevX/xcoder), Developer: [MasterDevX](https://github.com/MasterDevX)</br> |
40 | 44 |
|
41 |
| -Many thanks to [spiky_Spike](https://github.com/spiky-s) for the provided developments |
| 45 | +XCoder is based on the original [XCoder](https://github.com/MasterDevX/xcoder), developed by [MasterDevX](https://github.com/MasterDevX).</br> |
| 46 | +Special thanks to [spiky_Spike](https://github.com/spiky-s) for their contributions. |
0 commit comments