创造你的第一个mod

基础

当想要创建一个NorthStar能使用的Mod时候，你需要先给你的mod工程文件夹创建一些东西：

  1. 一个叫mod.json的文件
  2. 一个名为mod的文件夹

你在mod文件夹中存放的文件将会直接读被引擎的虚拟文件系统读取。如果你弄过vpk的mod大概就明白了，这是类似的。

如果在这个文件夹添加游戏已经存在的文件的话，将会覆写掉原本存在的同名文件。

举个例子，如果你现在mod文件夹路径下有如下文件My.Mod/mod/resource/coolfile.png,那么将会覆写任何读取resource/coolfile.png的文件。

可以给mod文件添加 par scripts ，不过需要在mod.json里面定义，已经存在的scripts不需要定义。

Mods可以通过读取优先级(priority)来覆写其他mods。优先级0为开始读取的第一个，然后数字增大就按着数字顺序读取。比如，MyCoolAwesomeSwag.Mod设置的优先级是0,那么会被第一个读取，然后MyTerribleAwful.Creation优先级设置的是1,那么它会被第二个读取。

编写 mod.json

  1. {
  2.   "Name": "Example.Mod",
  3.   "Description": "Woo yeah wooo!",
  5.   "LoadPriority": 0,
  6.   "ConVars": [],
  7.   "Scripts": [],
  8.   "Localisation": []
  9. }

上面提供了样例来给你使用

快速总结一下上面用到所有的参数：

  • "Name": Mod会在菜单和控制台显示的名字
  • "Description": 简单描述mod作用
  • "LoadPriority": mod读取的优先级
  • "ConVars": Source ConVars the mod defines which can have flags (see ConVars)
  • "Scripts": Custom squirrel scripts the mod loads (see Scripts)
  • "Localisation": mod文件的位置

See Cheatsheet for a more comprehensive list

添加定制 Scripts

任意你新创建的 .nut/.gunt 文件必须在在你的mod.json文件中的"Scripts"项定义 举个例子:

  1.   "Scripts": [
  2.       {
  3.           "Path": "path/to/my.nut",
  4.           "RunOn": "( CLIENT || SERVER ) && MP"
  5.       },
  6.       {
  7.           "Path": "path/to/my_second.nut",
  8.           "RunOn": "( CLIENT || SERVER ) && MP",
  9.           "ClientCallback": {
  10.               "Before": "ClientPreMapspawnThing",
  11.               "After": "AfterMapspawnClientThing"
  12.           },
  13.           "ServerCallback": {
  14.               "Before": "ServerPreMapspawncrap",
  15.               "After": "ServerAfterMapspawnWoo"
  16.           }
  17.       }
  18.   ],

Path 指的是你脚本文件的路径，然后 RunOn 指的是需要被编译用于脚本的 VM contexts

Path specifies the path to the script file and RunOn are the VM contexts for the script to be compiled on.

客户端和服务端的回调（callbacks）能发生在 mapspawn 之前或之后。他们会执行一个你脚本中定义的一个函数（function），当然，这依据于你运行在什么 VM context 上。未来可能会增加支持更多回调。

Client and server callbacks can either happen before or after mapspawn. They will call a function defined in your script, of course, these depend on what VM context you’re running. Future support may be added for more callbacks.

原文章链接