From cf67516041d7ff04e9a29f8355ded6e5dd226e1e Mon Sep 17 00:00:00 2001
From: LegendaryGuard <rootuser999@gmail.com>
Date: Fri, 19 Mar 2021 19:57:29 +0000
Subject: [PATCH] Create SMB modpack dev guide page

---
 SMB-modpack.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 SMB-modpack.md

diff --git a/SMB-modpack.md b/SMB-modpack.md
new file mode 100644
index 0000000..ac65fd4
--- /dev/null
+++ b/SMB-modpack.md
@@ -0,0 +1,42 @@
+**[SMB modpack](https://github.com/MarioSMB/modpack)** project is developed by **[Mario](https://github.com/MarioSMB)**.
+
+The modpack build works using a submodule from '_xonotic-dat.pk3dir_' from the official gamelogic development repository.
+
+Uses **update.sh** and **build.sh** shell script files. 
+
+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.
+
+<br/>
+
+The submodule of this modpack was created using: 
+
+`git submodule add https://gitlab.com/xonotic/xonotic-data.pk3dir xonotic`
+
+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):
+
+`git submodule update --remote --merge`
+
+It'll update the content where is in the official gamelogic development repository in your modpack repository.
+*(Additionally, after done this, if you do the commit:*
+
+*`git status`*
+
+*`git add xonotic`*
+
+*`git commit -m "Update submodule xonotic test"`*
+
+*`git push origin master #depends what origin and what branch you're using to do your commits`*
+
+*)*
+
+Inside '_update.sh_', there is a line: 
+
+`git submodule update --init --depth 100`
+
+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.
+
+<br/>
+
+'_./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.
+
+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_'.
\ No newline at end of file
-- 
2.39.2