|
7 | 7 |
|
8 | 8 |
|
9 | 9 | /** |
10 | | - * @mainpage |
| 10 | + * @mainpage Simutrans Code Documentation |
11 | 11 | * |
12 | | - * Simutrans |
13 | | - * |
14 | | - * @tableofcontents |
15 | | - * |
16 | | - * Simutrans Code Documentation |
17 | 12 | * |
18 | 13 | * License |
19 | 14 | * ======= |
|
31 | 26 | * The scripts have to be written in squirrel. The manual can be found at <a href="http://squirrel-lang.org/">Squirrel main page</a>. |
32 | 27 | * As squirrels like to crack nuts, understandably the script files get the extension '.nut'. |
33 | 28 | * |
34 | | - * @subsection sec_scenarios Scripted scenarios |
35 | | - * |
36 | | - * .... |
37 | | - * |
38 | | - * ### How to create a scenario. |
39 | | - * |
40 | | - * You first need an @e idea - a vision what a scenario may look like. Then you have |
41 | | - * to cast this idea into a @e savegame. That is, create the world in which your scenario will live. |
42 | | - * You are the ruler of this toy universe, you are in charge of the rules, which go into the @e script. |
43 | | - * |
44 | | - * ### Recommended directory structure |
45 | | - * |
46 | | - * The scenario plays in a savegame. This savegame is tied to the pak-set you are using (e.g. pak64, pak128.Britain). |
47 | | - * Hence, the scenario files have to go into a sub-folder of the pak-set. |
48 | | - * The pak-set is found in a directory named pak-something, which is in the same directory, where the program |
49 | | - * itself is located or under user-directory/addons/. |
50 | | - * |
51 | | - * Your scenario file goes into the folder |
52 | | - * |
53 | | - * <tt> |
54 | | - * pak-something/scenario/myscenario/ |
55 | | - * </tt> |
56 | | - * |
57 | | - * Scenarios can also be put into the addons folder: |
58 | | - * |
59 | | - * <tt> |
60 | | - * addons/pak-something/scenario/myscenario/ |
61 | | - * </tt> |
62 | | - * |
63 | | - * |
64 | | - * @subsection sec_ai_player Scripted AI players |
65 | | - * |
66 | | - * .... |
67 | | - * |
68 | | - * ### Recommended directory structure |
69 | | - * |
70 | | - * Your script file goes into the folder |
71 | | - * |
72 | | - * <tt> |
73 | | - * ai/myai/ |
74 | | - * </tt> |
75 | | - * |
76 | | - * The main script file must be |
77 | | - * |
78 | | - * <tt> |
79 | | - * ai/myai/ai.nut |
80 | | - * </tt> |
81 | 29 | * |
82 | | - * The ai scripts can also be put into |
| 30 | + * For more information see <a href="https://doc.simutrans-germany.com/Simutrans-Squirrel-API/index.html">Simutrans-Squirrel-API Documentation</a>. |
83 | 31 | * |
84 | | - * <tt> |
85 | | - * addons/ai/myai/ |
86 | | - * </tt> |
87 | | - * |
88 | | - * @subsection sec_scripted_tools Scripted tools |
89 | | - * |
90 | | - * .... |
91 | | - * |
92 | | - * ### Recommended directory structure |
93 | | - * |
94 | | - * The script file (tool.nut) as well as the configuration file (description.tab) go into |
95 | | - * |
96 | | - * <tt> |
97 | | - * pak-something/tool/mytool/ |
98 | | - * </tt> |
99 | | - * |
100 | | - * Related pak-files have to be placed in |
101 | | - * |
102 | | - * <tt> |
103 | | - * pak-something/ |
104 | | - * </tt> |
105 | | - * |
106 | | - * |
107 | | - * Check out the sections on the <a href="modules.html">Modules</a> page. |
108 | 32 | */ |
109 | 33 |
|
110 | 34 |
|
111 | | - |
112 | 35 | /** |
113 | | - * @defgroup squirrel-scen-api Squirrel scenario interface |
114 | | - * |
115 | | - * The following methods are vital for the functioning of a scripted scenarios. |
116 | | - * They will be called from simutrans to interact with the script. You should consider |
117 | | - * implementing them. |
118 | | - * |
119 | | - */ |
120 | | - |
121 | | - /** |
122 | | - * @defgroup squirrel-ai-api Squirrel ai interface |
123 | | - * |
124 | | - * The following methods are vital for the functioning of a scripted AI. |
125 | | - * They will be called from simutrans to interact with the script. You should consider |
126 | | - * implementing them. |
127 | | - * |
128 | | - */ |
129 | | - |
130 | | - /** |
131 | | - * @defgroup squirrel-tool-api Squirrel tool interface |
132 | | - * |
133 | | - * The following methods are vital for the functioning of scripted tools. |
134 | | - * They will be called from simutrans to interact with the script. You should consider |
135 | | - * implementing them. |
136 | | - * |
137 | | - */ |
138 | | - |
139 | | - /** |
140 | 36 | * @defgroup squirrel-toolkit-api Squirrel toolkit interface |
141 | 37 | * |
142 | 38 | * The following methods create macro scripted tools. |
|
0 commit comments