Skip to content

Commit 68f1fcb

Browse files
committed
Made the README up-to-date.
1 parent ceb7e96 commit 68f1fcb

File tree

4 files changed

+30
-14
lines changed

4 files changed

+30
-14
lines changed

Media/conversion-rules-screenshot.png

106 KB
Loading
164 Bytes
Loading

Python/gui.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ def init_window():
4545
sg.FolderBrowse(size=(7, 1))
4646
],
4747
[
48-
sg.ProgressBar(999, size=(34.2, 32), key="-PROGRESS BAR-"),
49-
sg.Button("Convert", key="-CONVERT-", size=(7, 1), pad=((5, 0), (0, 15)))
48+
sg.ProgressBar(999, size=(34.2, 40), key="-PROGRESS BAR-"),
49+
sg.Button("Convert", key="-CONVERT-", size=(7, 1), pad=((5, 0), (14, 15)))
5050
]
5151
], title="Convert Mods")]
5252
]

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,47 @@
55
This project automates ***most*** of the conversion work required to convert the legacy (old) `Cortex Command` mods into `Cortex Command Community Project` compatible mods.
66

77
## Getting started
8-
Download the [***Legacy Mod Converter***](https://www.mediafire.com/file/cl3vfatqkoqmop1/Legacy+Mod+Converter.exe/file) program. Create a new folder and put your legacy mods that you want to convert in it. Run the Legacy Mod Converter program.
8+
Download the [***Legacy Mod Converter***](https://www.mediafire.com/file/cl3vfatqkoqmop1/Legacy+Mod+Converter.exe/file) program. Create a new folder and put your legacy mods that you want to convert in it. Open the Legacy Mod Converter program.
99

1010
<p align="center"><img src="Media/legacy-mod-converter-screenshot.png" alt="Legacy Mod Converter screenshot"></p>
1111

1212
If you get a "`Microsoft Defender SmartScreen prevented an unrecognized app from starting. Running this app might put your PC at risk.`" popup message when trying to run the program you should press `More info` and then `Run anyway`.
1313

1414
## Disclaimer
15-
This program will do most of the conversion work for you, but some conversion steps are too hard to automate, so it's likely that `CCCP` will still crash or print errors in the console. If this happens you'll have to manually fix these issues in the legacy mod folder. If you want to properly fix these errors then you should download this repository and follow the instructions below so you can add your own conversion cases to `conversion_rules.py`.
15+
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.
16+
17+
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.
18+
19+
## What are conversion rules
20+
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.
21+
22+
Take for example this line from `ConversionRules/Misc.json`:
23+
24+
`"Round M16": "Round Ronin M16",`
25+
26+
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.
27+
28+
<p align="center"><img src="Media/conversion-rules-screenshot.png" alt="Conversion rules screenshot"></p>
1629

1730
## How to add your own conversion rules
18-
* Download Python 3 and this GitHub repository.
19-
* Change your directory to the `cc-legacy-mod-converter` repository in your terminal.
20-
* Run `python main.py` when you want to convert old mods.
21-
* `conversion_rules.py` has the `conversion_rules` dictionary inside of it. The dictionary contains entries that look like `'foo': 'bar',` which means means that any time `foo` is encountered in a legacy mod it will be replaced with `bar`. You can also add extra conversion cases to it; see the next sections on how to do this in detail.
31+
Open any of the JSON files in the `ConversionRules` folder and add the line `"": "",` in a similar manner to how the other lines are placed. You can then start putting stuff between the quotation marks on the left and right side like in the example in the section above. The converter will now know how to apply one more conversion rule.
32+
33+
If you put the right things between the quotes that CCCP was complaining about then you can start the converter once more and you'll see that the crash/error should have disappeared. Repeat this process until the mod is fully converted and playable with no console errors (to check for console errors press the `` ` `` key in CCCP).
2234

2335
## Tutorials on constructing conversion rules efficiently
36+
37+
### Programs that can help with creating conversion rules
38+
**You don’t need all of these programs to get started and feel free to use alternative programs:**
39+
40+
* [Download “Everything”](https://voidtools.com/) - Like File Explorer on Windows. Very accurate and fast.
41+
* [Download “SourceTree”](https://www.sourcetreeapp.com/) - Like GitHub Desktop. Allows searching for specific words across all commits, which is super useful when for example you want to figure out what `Nanorifle` got changed to when that's crashing CCCP.
42+
* [Download “Notepad++”](https://notepad-plus-plus.org/downloads/) - Like Notepad. Allows mass replacing across thousands of files at once. You can also use an IDE like [VS Code](https://code.visualstudio.com/) for this purpose.
43+
44+
### Tutorials on how to use the programs effectively.
2445
* [Fixing CCCP crashes/errors with the program Everything](https://github.com/cortex-command-community/Cortex-Command-Legacy-Mod-Converter/wiki/Fixing-CCCP-crashes-errors-with-the-program-Everything)
2546

2647
## Contributing
2748
Feel free to submit `Pull Requests` or `Issues` on this GitHub project for any additional cases that you'd like to have supported.
2849

29-
**You don’t need all of these programs to get started and feel free to use alternative programs:**
30-
* [Download “Everything”](https://voidtools.com/) - Like File Explorer on Windows. Very fast.
31-
* [Download “SourceTree”](https://www.sourcetreeapp.com/) - Like GitHub Desktop. Allows searching for specific words across all commits.
32-
* [Download “NotePad++”](https://notepad-plus-plus.org/downloads/) - Like Notepad. Allows mass replacing across many files. You can also use an IDE like [VS Code](https://code.visualstudio.com/) instead for this.
33-
3450
## Getting help
35-
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! :)
51+
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! :)

0 commit comments

Comments
 (0)