ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

Difference between revisions of "Rules.ini"

From ModEnc
Jump to: navigation, search
(→‎Script to Read UnitsIdCode in Rules.ini)
m (→‎Python 3)
Line 48: Line 48:
 
  # need to modify the rules.ini if there are any error reports during reading it by module configparser
 
  # need to modify the rules.ini if there are any error reports during reading it by module configparser
 
  rules_dir=r"C:\Users\August\Documents\rulesmo_mod.ini"
 
  rules_dir=r"C:\Users\August\Documents\rulesmo_mod.ini"
−
  # rules_dir=r"/storage/emulated/0/1/rulesmo_md.ini"
+
  # rules_dir=r"/storage/emulated/0/1/rulesmo_mod.ini"
 
  # set the output file directory
 
  # set the output file directory
 
  ofdir=r"C:\Users\August\Documents\UnitCodes.txt"
 
  ofdir=r"C:\Users\August\Documents\UnitCodes.txt"

Revision as of 07:23, 14 February 2024

The rules.ini (naming variations for expansions) is the core file of C&C modding. As indicated by the name, it contains the "rules" of the game – the properties of every object, weapon, warhead, etc. in the game. For any C&C game from Red Alert to Yuri's Revenge, this is the main modification file. For Generals and everything else based on the SAGE engine, the INI-system is more complex and wide-spread.

Disregarding the side functions of the other various INI files (like ai.ini or art.ini), there is no way to make any changes to the game other than what the rules.ini allows for1. Not everything in the game is customizable. Features that cannot be modified are called "hardcoded" features.


File Locations

Game Location Notes
Red Alert redalert.mix → local.mix
Tiberian Sun tibsun.mix → local.mix The patches add a new rules.ini to patch.mix
Firestorm expand01.mix rules-equivalent is called firestrm.ini, the mix also contains a new rules.ini for regular TS.
Red Alert 2 ra2.mix → local.mix
Yuri's Revenge expandmd01.mix Called rulesmd.ini, for mission disk.
Mental Omega expandmo99.mix Called rulesmo.ini, for Mental Omega.

Script to Read UnitsIdCode in Rules.ini

Python 3

This script will read the rules.ini and list the UnitType, SequenceNum, UnitIdCode, UnitUIName, UnitInternalName and Armor, and store these informations into a txt file.

To get the CSF.ini that required in this script, please go to page CSF File Format.

ReadRulesCode.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74 
# set the directory of rules.ini here
# need to modify the rules.ini if there are any error reports during reading it by module configparser
rules_dir=r"C:\Users\August\Documents\rulesmo_mod.ini"
# rules_dir=r"/storage/emulated/0/1/rulesmo_mod.ini"
# set the output file directory
ofdir=r"C:\Users\August\Documents\UnitCodes.txt"
# ofdir=r"/storage/emulated/0/1/UnitCodes.txt"
# set the directory of CSF.ini that decoded by ReadCsf.py
csf_ini_dir=r"C:\Users\August\Documents\CSF.ini"
# csf_ini_dir=r"/storage/emulated/0/1/CSF.ini"

from configparser import ConfigParser
import os
# read rules.ini
rules=ConfigParser(delimiters="=")
rules.read(rules_dir)
# read CSF.ini if it exists
if os.path.isfile(csf_ini_dir):
    csf=ConfigParser(delimiters="=")
    csf.read(csf_ini_dir, "UTF-8")
# sections of unit types
type_list=["InfantryTypes", "VehicleTypes", "AircraftTypes", "BuildingTypes", "SuperWeaponTypes"]
# the attributes of the unit we need as the ini options
attr_list=["UIName", "Name", "Armor"]
def clear_file(file_path: str):
    """clear the file especially the file for output"""
    with open(file_path, "w", encoding="UTF-8"):
        pass
def add_to_file(file_path: str, content: str):
    """write a string into the file in addition mode"""
    with open(file_path, "a", encoding="UTF-8") as f:
        f.write(content)
def cut_ref(content: str) -> str:
    """cut the reference in ini file"""
    if ";" in content:
        content=content.replace(content[content.find(";"):], "")
    return content.replace("\t", "").replace(" ", "")

# clear the output file
clear_file(ofdir)
for unitype in type_list:
    # store the header of UnitType
    txt="== "+unitype+" ==\n"
    for seqnum in rules[unitype]:
        idcode=cut_ref(rules[unitype][seqnum])
        # record the infomations in "line"
        line=seqnum+"\t"+idcode+"\t"
        for attr in attr_list:
            # SuperWeapons/SupportPowers does not have Armor
            if unitype=="SuperWeaponTypes" and attr=="Armor":
                pass
            # if the unit has the general attributes listed above
            elif rules.has_option(idcode, attr):
                # try to translate UIName by CSF if the CSF exists
                if attr=="UIName" and os.path.isfile(csf_ini_dir):
                    # browse the CSF for UIName by order
                    for section in csf:
                        if csf.has_option(section, rules[idcode][attr]):
                            UIName=csf[section][rules[idcode][attr]]
                    line+=UIName+"\t"
                else:
                    line+=rules[idcode][attr]+"\t"
            else:
                line+="N/A\t"
        line=line[:-1]+"\n"
        # add the line into the "txt"
        txt+=line
    # write the "txt" into the output file
    add_to_file(ofdir, txt+"\n")
# try to open the output file, may fail if the OS does not support
try:
    os.startfile(ofdir)
except:
    pass

Footnotes

1 ↑ An exception to this would be pd's RockPatch.

See Also

Retrieved from "https://modenc.renegadeprojects.com/index.php?title=Rules.ini&oldid=22467"