SMB-modpack.md

   1 **[SMB modpack](https://github.com/MarioSMB/modpack)** project is developed by **[Mario](https://github.com/MarioSMB)**.
   2
   3 The modpack build works using a submodule from '_xonotic-dat.pk3dir_' from the official gamelogic development repository.
   4
   5 Uses **update.sh** and **build.sh** shell script files.
   6
   7 Uses '_update.sh_' to obtain the content of '_gmqcc_', '_xonotic-data.pk3dir_' in '_xonotic_' folder and '_csprogs_' in '_.cache_' folder. Clearly, needs gmqcc to be able to compile, this means that '_build.sh_' calls gmqcc to compile the code.
   8
   9 <br/>
  10
  11 The submodule of this modpack was created using:
  12
  13 `git submodule add https://gitlab.com/xonotic/xonotic-data.pk3dir xonotic`
  14
  15 The submodule in the repository is used when need to update the code from '_xonotic-data.pk3dir_', to do this if you've a fork or a copy of SMB modpack repository, you'll have to update using (note: in your local computer, you should have used '_./update.sh_' to download fully the content of '_xonotic-data.pk3dir_' in '_xonotic_' folder):
  16
  17 `git submodule update --remote --merge`
  18
  19 It'll update the content where is in the official gamelogic development repository in your modpack repository.
  20 *(Additionally, after done this, if you do the commit:*
  21
  22 *`git status`*
  23
  24 *`git add xonotic`*
  25
  26 *`git commit -m "Update submodule xonotic test"`*
  27
  28 *`git push origin master #depends what origin and what branch you're using to do your commits`*
  29
  30 *)*
  31
  32 Inside '_update.sh_', there is a line:
  33
  34 `git submodule update --init --depth 100`
  35
  36 Means that when you use '_./update.sh_' with this line, the submodule content will be downloaded in your local computer where you've cloned the modpack repository.
  37
  38 <br/>
  39
  40 '_./build.sh_' compiles all repository code using gmqcc if already downloaded from '_./update.sh_', looks inside '_mod_' folder the similar contents of '_xonotic-data.pk3dir/qcsrc_' where there are: '_client_', '_common_', '_menu_' and '_server_' folders.
  41
  42 What it does is relate the directory path to the submodule '_xonotic_' directory inside the '_qcsrc_' folder. Thanks to this, it makes it possible to look at the '_mod_' folder having to relate the submodule directory '_xonotic/qcsrc_'.