Skip to content

Commit 4acd23c

Browse files
author
memo
committed
adds readme and license
1 parent 7770f37 commit 4acd23c

3 files changed

Lines changed: 74 additions & 2 deletions

File tree

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2013 memo
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
2+
NAMControllerCompiler
3+
=======================
4+
(Version 1.0.0)
5+
6+
7+
Contents
8+
----------
9+
10+
This application allows to compile a customized NAM controller file for the
11+
_Network Addon Mod_ for _SimCity 4_. This helps minimizing the size of the
12+
controller, and thus loading times of the game, by installing only those
13+
override rules that are required for one's personal style of using the NAM.
14+
15+
By default, the NAM installer builds a controller file that contains those rules
16+
that are necessary for the required components. Using this application, it is
17+
possible to exclude rules, even if the corresponding networks exist in your
18+
cities. For instance, you can deselect various RHW networks as long as you don't
19+
plan to touch those networks during your game play. The game will start much
20+
faster, then. Note that redragging these RHW networks would revert the network
21+
to RHW-2 because the required override rules are absent. In this case, run the
22+
compiler again to build a different compiler that includes the RHW networks you
23+
want to use.
24+
25+
To start this application, double-click the file `NAMControllerCompiler.bat`.
26+
The compiler cannot build a new controller while the game is running.
27+
28+
29+
Installation
30+
--------------
31+
32+
This program is automatically installed by the NAM installer. The location
33+
will be next to the Plugins folder, typically:
34+
35+
Documents/SimCity 4/NAM Auxiliary Files/Controller Compiler/
36+
37+
38+
Contact and Support
39+
---------------------
40+
41+
Support is provided at
42+
[SC4Devotion.com](http://sc4devotion.com/forums/index.php?board=90.0).
43+
44+
The source files can be found at
45+
[GitHub.com](https://github.com/memo33/NAMControllerCompiler).
46+
47+
48+
License
49+
---------
50+
51+
This program is released under the MIT license (see included license file).
52+

build.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ start /min cmd /C "java -jar ${MyApp}.jar %* || %windir%\SysWOW64\java -jar ${My
118118
<!-- Create zip file with sources -->
119119
<zip destfile="${dist}/${MyApp-zipname}_sources_and_tests.zip">
120120
<fileset dir="${basedir}" includes="${manifest.build.classpath}" />
121-
<fileset dir="${basedir}" includes="${MyApp}*,build.xml,ivy.xml" />
121+
<fileset dir="${basedir}" includes="${MyApp}*,build.xml,ivy.xml,README.md,LICENSE" />
122122
<!-- source files -->
123123
<fileset dir="${basedir}" includes="${src}/**" />
124124
<fileset dir="${basedir}" includes="${srctest}/**" />
@@ -134,7 +134,7 @@ start /min cmd /C "java -jar ${MyApp}.jar %* || %windir%\SysWOW64\java -jar ${My
134134
<!-- Create dist zip file -->
135135
<zip destfile="${dist}/${MyApp-zipname}.zip">
136136
<fileset dir="${basedir}" includes="${manifest.build.classpath}" />
137-
<fileset dir="${basedir}" includes="${MyApp}*" />
137+
<fileset dir="${basedir}" includes="${MyApp}*,README.md,LICENSE" />
138138
<fileset dir="${basedir}" includes="${xml.resources}/${rul2.structure.file}.dtd" />
139139
<fileset dir="${basedir}" includes="${xml.resources}/${rul2.structure.file}_default.xml" />
140140
<zipfileset dir="${basedir}" includes="${xml.resources}/${rul2.structure.file}_default.xml" fullpath="${xml.resources}/${rul2.structure.file}.xml" />

0 commit comments

Comments
 (0)