Skip to content

Commit 32dfefd

Browse files
refactor: main file moved to xcoder package
1 parent c9937f2 commit 32dfefd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+427
-412
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
/SC/
1111

1212
# Configuration files
13-
system/config.json
13+
xcoder/config.json
1414

1515
# Python compiled files
1616
*.pyc

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,41 @@ Supercell\`s games.
99

1010
### Features:
1111

12-
- SC compile / decompile;
13-
- Compression and decompression.
12+
- SC compile / decompile
13+
- Compression and decompression
1414

1515
### How to install and use
1616

1717
- On Windows:
1818
- Download Python 3.10 or newer version
19-
from [official page](https://www.python.org/downloads/);
19+
from [official page](https://www.python.org/downloads/)
2020
- 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
23-
the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
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
2423
- Locate the extracted directory and install required modules:
2524
```cmd
2625
poetry install
2726
```
28-
- Execute "main.py" file.
27+
- Run program with
28+
```cmd
29+
poetry run python -m xcoder
30+
```
2931
3032
- On Linux:
31-
- Open Terminal and install Python by executing following command:
32-
```sudo apt-get update && sudo apt-get install python3 python3-poetry```;
33-
- Download XCoder from
34-
the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
35-
- Locate the extracted directory and install required modules by executing following
36-
command:
37-
```sh
38-
poetry install
39-
```
40-
- Execute "main.py" file.
33+
- Open Terminal and install Python by executing following command:
34+
```sh
35+
sudo apt-get update && sudo apt-get install python3 python3-poetry
36+
```
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:
40+
```sh
41+
poetry install
42+
```
43+
- Run program with
44+
```cmd
45+
poetry run python -m xcoder
46+
```
4147
4248
### Testing
4349
@@ -58,7 +64,7 @@ perform this step.**
5864
To enable the KTX module, you need to get the "PVRTexToolCLI" binary from the official
5965
site: https://developer.imaginationtech.com/pvrtextool/.
6066

61-
Then it is necessary to put CLI in "system/bin/" folder in the main script folder.
67+
Then it is necessary to put CLI in "bin/" folder in the main script folder.
6268

6369
### In the plans:
6470

system/exceptions/__init__.py

Lines changed: 0 additions & 3 deletions
This file was deleted.

system/lib/__init__.py

Lines changed: 0 additions & 20 deletions
This file was deleted.

system/lib/config.py

Lines changed: 0 additions & 52 deletions
This file was deleted.

system/lib/math/__init__.py

Whitespace-only changes.

system/lib/objects/__init__.py

Lines changed: 0 additions & 5 deletions
This file was deleted.

system/lib/objects/movie_clip/__init__.py

Lines changed: 0 additions & 4 deletions
This file was deleted.

system/lib/objects/renderable/__init__.py

Whitespace-only changes.

system/lib/objects/shape/__init__.py

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)