X-Git-Url: https://git.xonotic.org/?a=blobdiff_plain;f=SMB-modpack.md;h=163d7da0d2a6639427925f78040872929235a3a4;hb=47bca4af7c97926653f00e676e4c429d223e5ada;hp=e1e0b72f053f2acaaf9332cceeb5567ac3ebf75c;hpb=91002429731d4fd5e52dbf5ebc589f41a051104a;p=xonotic%2Fxonotic.wiki.git diff --git a/SMB-modpack.md b/SMB-modpack.md index e1e0b72..163d7da 100644 --- a/SMB-modpack.md +++ b/SMB-modpack.md @@ -1,20 +1,20 @@ -**[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` @@ -24,7 +24,11 @@ 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. +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. + +To run '_update.sh_' script, you should go to the current directory where is this script and execute: + +`./update.sh` ### Commit with submodule @@ -38,8 +42,12 @@ Additionally, after done `git submodule update --remote --merge`, if you want to `git push origin master #depends what origin and what branch of repository you're using to do your commits` -## ./build.sh +## build.sh + +'_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 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