diff options
Diffstat (limited to 'docs/bash_system.md')
| -rw-r--r-- | docs/bash_system.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/bash_system.md b/docs/bash_system.md new file mode 100644 index 0000000..744a7ad --- /dev/null +++ b/docs/bash_system.md @@ -0,0 +1,33 @@ +# BASH system + +AzerothCore uses an advanced bash system that allows us to automate processes such as the sources **compilation, module installation, database setup etc.** + +For now we are using bash instead of Python to reduce external dependencies since BASH is a crossplatform scripting language that is already included +with **OSX, Linux and Windows** (via GIT BASH that we ask you to install in our requirements). + +You can read the official bash documentation here: https://tldp.org/LDP/abs/html/index.html + +## ACORE DASHBOARD + +Our azerothcore related bash scripts can be found inside the /app folder, but we also created a script called **acore.sh** within the root folder. +This script runs a dashboard that contains the commands to run all scripts related to the /app folder. + +run `./acore.sh --help` for the entire list of the available commands. + +### Interactive mode + +run `./acore.sh` and you can use the dashboard in interactive mode: you can navigate within the dashboard menu and sub-menu and run the command you need + +### Command arguments + +You can use the commands of the dashboard as arguments of the ./acore.sh script. For instance: + +`./acore.sh compiler configure` will run the configuration process of our c++ compiler + +All commands come with a shorter alias. For example `./acore.sh c configure` will run the compiler configuration, but also `./acore.sh 5 3` will do it. + + +## DEPS + +Our bash system uses external bash libraries that are generic and not related to the azerothcore itself, those libraries have been created by us and +have been placed under /deps folder |
