Skip to content

Commit 18a1cad

Browse files
committed
Update the README
1 parent 08924cc commit 18a1cad

9 files changed

+11
-46
lines changed

Media/conversion-rules-screenshot.png

-31.1 KB
Binary file not shown.

Media/converter.png

18.4 KB
Loading

Media/discord-icon-original.png

-8.27 KB
Binary file not shown.

Media/discord-icon.png

-1.14 KB
Binary file not shown.

Media/finish.wav

-22.9 KB
Binary file not shown.

Media/github-icon.png

-1.49 KB
Binary file not shown.
-18.1 KB
Binary file not shown.

Media/legacy-mod-converter.ico

-101 KB
Binary file not shown.

README.md

Lines changed: 11 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,25 @@
22
<h1 align="center">Cortex Command Legacy Mod Converter</h1>
33

44
## Introduction
5-
This project automates ***most*** of the conversion work required to convert the legacy (old) `Cortex Command` mods into `Cortex Command Community Project` compatible mods.
65

7-
<p align="center"><img src="Media/legacy-mod-converter-screenshot.png" alt="Legacy Mod Converter screenshot"></p>
6+
Automatically converts mods to the latest version of the [Cortex Command Community Project](https://github.com/cortex-command-community/Cortex-Command-Community-Project).
87

9-
## Getting started
10-
Follow the instructions for the latest release [here](https://github.com/cortex-command-community/Cortex-Command-Legacy-Mod-Converter/releases).
8+
This program presents a GUI for the [Cortex Command Mod Converter Engine](https://github.com/MyNameIsTrez/Cortex-Command-Mod-Converter-Engine) library that is doing the hard work behind the scenes.
119

12-
## Disclaimer
13-
This program will do most of the conversion work for you, but even though this converter will already automatically apply more than 500 mod changes that have been made between Cortex Command and CCCP there are always more changes out there that haven't been added to the converter yet.
10+
![Screenshot of the mod converter's GUI](Media/converter.png)
1411

15-
It's for this reason that it's almost guaranteed that CCCP will still crash with a crash message or with errors in the console after conversion, but the point of this converter is to do 99% of the work for you, 100% is only realistic for some tiny mods. You'll want to manually fix these issues using the instructions in the next section.
12+
## Installation
1613

17-
## What are conversion rules
18-
Conversion rules are a way of informing the program of the changes that have been made between Cortex Command and CCCP and how it can fix them. These conversion rules are stored in JSON files in the `ConversionRules` folder. You absolutely don't need to have any programming experience to start adding conversion rules to any of the JSON files.
14+
Go to the [releases page](https://github.com/cortex-command-community/Cortex-Command-Legacy-Mod-Converter/releases).
1915

20-
Take for example this line from `ConversionRules/Misc.json`:
16+
## Conversion rules
2117

22-
`"Round M16": "Round Ronin M16",`
23-
24-
What this line of JSON says is that whenever the thing on the left is encountered in a mod, it should be replaced with whatever is on the right of it. So, this conversion rule says that whenever `Round M16` is encountered in a mod that's being converted it should be changed to `Round Ronin M16` by the converter.
25-
26-
<p align="center"><img src="Media/conversion-rules-screenshot.png" alt="Conversion rules screenshot"></p>
27-
28-
## How to add your own conversion rules
29-
Follow [this tutorial on fixing CCCP crashes and errors with Fork](https://github.com/cortex-command-community/Cortex-Command-Legacy-Mod-Converter/wiki/Fixing-CCCP-crashes-and-errors-with-Fork).
30-
31-
## If you want to run the latest version of the converter
32-
Clone or download this repository, run `pip install -r requirements.txt` and then run `python main.py`. Python version 3.10.1 or newer is recommended.
33-
34-
## Contributing
35-
Feel free to submit `Pull Requests` or `Issues` on this GitHub project for any additional cases that you'd like to have supported.
36-
37-
## Getting help
38-
If you need help with anything you can contact the creator of this repository directly (`#MyNameIsTrez1585` on Discord), or you can ask the friendly regulars in the CCCP Discord server in `#modding-discussion` for help. It helps us if you mention where you've gotten stuck while reading this tutorial, so please do that! :)
18+
This line from `rules/ini_copy_of_rules.json`:
3919

40-
## Build instructions
41-
42-
### Windows
43-
44-
Using a virtual environment brings the executable down from 34 MB to 30 MB:
45-
46-
1. `./virtual_environment/Scripts/activate.bat`
47-
2. `./virtual_environment/Scripts/python.exe -m pip install -r requirements.txt`
48-
3. `I:/programming/python/cc-legacy-mod-converter/virtual_environment/Scripts/pyinstaller --noconsole --onefile --icon="Media/legacy-mod-converter.ico" --collect-all="cortex_command_mod_converter_engine" --add-data="Media/github-icon.png;Media" --add-data="Media/discord-icon.png;Media" --add-data="Media/finish.wav;Media" --add-data="I:/Programming/Cortex-Command-Mod-Converter-Engine/src/cortex_command_mod_converter_engine/stylua_executables/windows/stylua.exe;windows" --name="Legacy Mod Converter" main.py`
49-
4. `./virtual_environment/Scripts/deactivate.bat`
50-
51-
### Linux
52-
53-
I haven't been able to build this for Linux yet.
54-
55-
This:
20+
`"Round M16": "Round Ronin M16",`
5621

57-
`pyinstaller --noconsole --onefile --icon="Media/legacy-mod-converter.ico" --add-data="Media/github-icon.png;Media" --add-data="Media/discord-icon.png;Media" --add-data="Media/finish.wav;Media" --add-binary="Lib/stylua/Linux/stylua:Lib/stylua/Linux" --add-data="Lib/stylua/Windows/stylua.exe;Lib/stylua/Windows" --name="Legacy Mod Converter" main.py`
22+
states that whenever `Round M16` is encountered by the converter, it should change it to `Round Ronin M16`.
5823

59-
gives the error:
24+
This means you can make the converter "smarter" by adding more rules to the JSON files in the `rules/` directory.
6025

61-
`pyinstaller: error: argument --add-binary: invalid add_data_or_binary value: 'Lib/stylua/Linux/stylua:Lib/stylua/Linux'`
26+
[This tutorial](https://github.com/cortex-command-community/Cortex-Command-Legacy-Mod-Converter/wiki/Fixing-CCCP-crashes-and-errors-with-Fork) goes over how you can use Fork to figure out what things were renamed to in the newer versions of the game, so you can add missing conversion rules.

0 commit comments

Comments
 (0)