Skip to content

Commit

Permalink
Rename script and config file to kf_compile_tool
Browse files Browse the repository at this point in the history
Kind of a breaking change, but all you need to do is to rename your config file.
  • Loading branch information
Shtoyan committed Nov 25, 2024
1 parent 1ca3008 commit ea38cef
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Build executable
run: |
pyinstaller --onefile Compile.py --name kf_compile_tool
pyinstaller --onefile kf_compile_tool.py
- name: Upload Release Asset
if: github.event_name == 'release'
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# KF Compile Tool

[`CompileSettings.ini`]: CompileSettings.ini
[`kf_compile_tool.ini`]: kf_compile_tool.ini
[`kf_compile_tool.py`]: kf_compile_tool.py
[release_badge]: <https://img.shields.io/github/downloads/InsultingPros/KFCompileTool/total?style=for-the-badge>
[build_badge]: https://img.shields.io/github/actions/workflow/status/InsultingPros/KFCompileTool/build.yml?style=for-the-badge

Expand All @@ -20,10 +21,10 @@ Killing Floor 1 advanced compilation script. Allows you to save hours of your li

## Installation and Setup

0. If you have [Python >3.10.x](https://www.python.org/) installed - clone the repository / get the `Compile.py` script.
0. If you have [Python >3.10.x](https://www.python.org/) installed - clone the repository / get the [`kf_compile_tool.py`].
1. If you don't know what Python is - grab the compiled exe from latest [release](https://github.com/InsultingPros/KFCompileTool/releases).
2. Put them whenever you want.
3. Start editing [`CompileSettings.ini`]. If you forget it - the default one will be created on first run.
3. Start editing [`kf_compile_tool.ini`]. If you forget it - the default one will be created on first run.

### Global Section

Expand Down Expand Up @@ -118,7 +119,7 @@ ComplexProject
- **bCreateINT** - set this to `True` to automatically create localization files.
- **bMakeRedirect** - set this to `True` to automatically compress compiled files.

If you feel lost after this description - check the [`CompileSettings.ini`] (it's as simple as possible) and try to compile something. Terminal will warn you about errors / missed lines.
If you feel lost after this description - check the [`kf_compile_tool.ini`] (it's as simple as possible) and try to compile something. Terminal will warn you about errors / missed lines.

## Requirements

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion Compile.py → kf_compile_tool.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
IGNORE_LIST: Final[list[str]] = [".git", "*.md", "Docs", "LICENSE"]
"""Filter for files-directories, so we copy-paste only source files"""

SETTINGS_FILE_NAME: Final[str] = "CompileSettings.ini"
SETTINGS_FILE_NAME: Final[str] = "kf_compile_tool.ini"
"""Settings file for this script, contains client-server directories and mods info"""
SETTINGS_FILE_CONTENT: Final[
str
Expand Down

0 comments on commit ea38cef

Please sign in to comment.