]> git.xonotic.org Git - xonotic/xonotic.wiki.git/blobdiff - SMB-modpack.md
Fix contents and effect code block
[xonotic/xonotic.wiki.git] / SMB-modpack.md
index 0cdce3e4353d557815d1999a8ae2164f27b82564..163d7da0d2a6639427925f78040872929235a3a4 100644 (file)
@@ -1,45 +1,53 @@
-**[SMB modpack](https://github.com/MarioSMB/modpack)** project is developed by **[Mario](https://github.com/MarioSMB)**.
+**[SMB modpack](https://github.com/MarioSMB/modpack)** project developed by **[Mario](https://github.com/MarioSMB)**.
 
-The modpack build works using a submodule from '_xonotic-dat.pk3dir_' from the official gamelogic development repository.
+The modpack build works using a submodule from '_xonotic-data.pk3dir_' from the official gamelogic development repository.
 
 Uses **update.sh** and **build.sh** shell script files. 
 
-# How submodule works, ./update.sh and ./build.sh
+# How submodule works, update.sh and build.sh
 
 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.
 
-## Submodule and ./update.sh
+## Submodule and update.sh
 
 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):
+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:*
+Inside '_update.sh_', there is a line: 
 
-*`git status`*
+`git submodule update --init --depth 100`
 
-*`git add xonotic`*
+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.
 
-*`git commit -m "Update submodule xonotic test"`*
+To run '_update.sh_' script, you should go to the current directory where is this script and execute:
 
-*`git push origin master #depends what origin and what branch you're using to do your commits`*
+`./update.sh`
 
-*)*
+### Commit with submodule
 
-Inside '_update.sh_', there is a line: 
+Additionally, after done `git submodule update --remote --merge`, if you want to commit:
 
-`git submodule update --init --depth 100`
+`git status`
+
+`git add xonotic`
+
+`git commit -m "Update submodule xonotic test"`
+
+`git push origin master #depends what origin and what branch of repository you're using to do your commits`
+
+## build.sh
 
-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.
+'_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.
 
-## ./build.sh
+What this does is relate the directory path to the submodule '_xonotic_' directory inside the '_qcsrc_' folder. Thanks to this, makes possible to look at the '_mod_' folder having to relate the submodule directory '_xonotic/qcsrc_'.
 
-'_./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.
+To run '_build.sh_' script, you should go to the current directory where is this script and execute:
 
-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
+`./build.sh`
\ No newline at end of file