Network Addon Mod (NAM) for SimCity 4 Deluxe/Rush Hour @ https://sc4devotion.com/forums/index.php?board=90.0
This repository contains the RUL files of the NAM.
For installation and usage of the NAM, see https://www.sc4nam.com/.
To help translate the NAM to different languages, see the Translation Guide.
The remainder of this README file is intended for developers.
├─┐ Controller/
│ ├── Bridge Controller/
│ ├── INI/
│ ├── INRULs/
│ ├── RUL0/
│ ├── RUL1/
│ └── RUL2/
├── Lite Controller/
├─┐ ltext/
│ ├── de/
│ ├── fr/
│ ...
├─┐ src/
│ ├─┐ main/
│ │ ├── resources/
│ │ └── scala/
│ └── test/
└── target/
The main code is contained in the folders INI, RUL0, RUL1, RUL2.
The files in there are used as input for the
the NAM Controller Compiler.
The folders Bridge Controller, INRULs
contain network related code that is not part of the NAM controller,
but is contained in other .dat files of the NAM.
The directory ltext contains sources for NAM LText files. Translations are contained within its subdirectories.
The directory src/main/scala contains code related to Metarules.
These are files written in the programming language Scala
that help automate the process of writing RUL2 code
as well as generating models and paths.
The generated files are written to the target directory.
Get the latest version of the NAM Controller Compiler.
Launch it and set the directory Controller as input for the Controller Compiler to generate the Controller .dat file.
Usually, this is the only task you need to do after modifying files in the INI, RUL0, RUL1 or RUL2 folders.
A script is provided to compile a full set of NAM controllers for release. Run it from the project root with:
./src/scripts/compile-release-controllers.sh "<version>"
The compiled controllers are located at ./target/controllers/.
Get the Java utility BuildRULs and run the command
java -jar /path/to/.../BuildRULs.jar -f Controller/INRULs/ Controller/INRULs/
and/or
java -jar /path/to/.../BuildRULs.jar -f "Controller/Bridge Controller/" "Controller/Bridge Controller/"
with the path to the BuildRULs.jar file replaced by the one on your system.
This creates or updates the files
┐ Controller/
└─┐ INRULs/
├── NetworkAddonMod_IndividualNetworkRULs_LHD.dat
├── NetworkAddonMod_IndividualNetworkRULs_RHD.dat
├── NetworkAddonMod_TurningLanes_Avenues_Plugin_INRULs.dat
└── NetworkAddonMod_Lite_INRULs.dat
or
┐ Controller/
└─┐ Bridge Controller/
└── NetworkAddonMod_Bridge_Controller.dat
Scripts are provided to compile a full set of INRULs and bridge controller for release. Run them from the project root with:
./src/scripts/compile-release-inruls.sh
./src/scripts/compile-release-bridge-controller.sh
The compiled files are located at ./target/controllers/.
Compiling the Metarules code is only needed when modifying any of the Scala code. For executing the Scala code, make sure you have sbt installed. It is a build tool that will download all the required dependencies.
Then execute
sbt run
to compile and run the Scala code. This takes the Metarules as input to generate RUL2 code and to create some models and paths. Currently, this generates the following files:
┐ target/
├── 11_FlexFly_falsies_MANAGED.txt
├── 5B00_FlexFly5x5_MANAGED.txt
├── FlexFly.dat
├── nwmTurnPaths.dat
└── Sec7j_FLEXFly_MANAGED.txt
You need to manually move the generated RUL2 files from the target directory
to the correct locations in the Controller directory and then commit them into the git repository.
For more information on Metarules, see https://github.com/memo33/metarules.
To convert all the translations contained in the directory ltext/ to a format that can be used by the game, use the tool sbt and run
sbt generateLocales
The generated .dat files are found at
┐ target/locale/
├── NetworkAddonMod_Locale_en.dat
├── NetworkAddonMod_Locale_it.dat
...
For information on adding and modifying LTexts, see the Translation & LText Guide.