diff options
| author | Alexander Pickering <alexandermpickering@gmail.com> | 2017-11-26 21:07:54 -0500 |
|---|---|---|
| committer | Alexander Pickering <alexandermpickering@gmail.com> | 2017-11-26 21:07:54 -0500 |
| commit | 83af51534bf16bf048aea1cd3b74a0308ed9dd71 (patch) | |
| tree | ff82f3e6dd841633b1355b73181bcae607ee1138 /tutorials/tut000_setup.md | |
| parent | 25e4d04a331a6a0b9d897d4f721757730771ff97 (diff) | |
| download | artery-83af51534bf16bf048aea1cd3b74a0308ed9dd71.tar.gz artery-83af51534bf16bf048aea1cd3b74a0308ed9dd71.tar.bz2 artery-83af51534bf16bf048aea1cd3b74a0308ed9dd71.zip | |
Started work on writing tutorials
Wrote tutorials for
* Setup
* Addon structure
* Inventories
* Items
Diffstat (limited to 'tutorials/tut000_setup.md')
| -rw-r--r-- | tutorials/tut000_setup.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/tutorials/tut000_setup.md b/tutorials/tut000_setup.md new file mode 100644 index 0000000..d71455f --- /dev/null +++ b/tutorials/tut000_setup.md @@ -0,0 +1,33 @@ +# Tut 0x000 + +## Setup and installation + +This tutorial covers how to set up Artery so you can begin developing. + +First, you'll need to download the Artery gamemode base. This can be done for updates with [git](https://git-scm.com)(reccomended) or just downloaded as a zip and extracted + +## Git setup + +1. Download [git](https://git-scm.com) +2. Follow the setup instructions +3. Open command prompt and type in `git --version`, verify that version information is printed. +4. Use the `cd` command to go into your Garry's Mod directory. This is usuallly `C:\Program Files (x86)\Steam\steamapps\common\GarrysMod\garrysmod` (i.e. the command would be `cd "C:\Program Files (x86)\Steam\steamapps\common\GarrysMod\garrysmod"`). You can alternatively go to this location in your file browser, then click the file path at the top, and copy+paste it into your command prompt. +5. Use `cd` again to go into your `gamemodes` directory (i.e `cd gamemodes`) +6. Clone the repository `git clone http://cogarr.net/source/cgit.cgi/artery` +7. Go back and clone the artery_editor addon (`cd ../addons` then `git clone http://cogarr.net/source/cgit.cgi/artery_editor`) +8. Another one `git clone https://cogarr.net/source/cgit.cgi/zones` _*_ Please note that this is a fork of [bobleheadbob's original api](https://github.com/Luabee/Zones), all it does is put the files into an addon format. +9. Finally, be sure you are subscribed to PAC3 on the steam workshop +10. Boot up gmod, select the artery addon, and load into gm_flatgrass to make sure it works! You can skip the next section, and go on to the next tutorial. + +## Non-git setup + +You'll be doing almost the same thing, only downloading zips instead of using the `git clone` command + +1. Go to [cogarr.net/source/cgit.cgi/artery](cogarr.net/source/cgit.cgi/artery) and click the latest version of the zip +2. Find your garrysmod folder, it'll useually be in `C:/Program Files (x86)/Steam/steamapps/common/GarrysMod/garrysmod` +3. Extract the folder into `garrysmod/gamemodes/` and rename the folder to `artery` so that `garrysmod/gamemodes/artery/README.md` is a valid file. +3. Downlaod the latest versions of [cogarr.net/source/cgit.cgi/artery_editor](cogarr.net/source/cgit.cgi/artery_editor) and [cogarr.net/source/cgit.cgi/zones](cogarr.net/source/cgit.cgi/zones), and extract them both into the `garrysmod/addons` folder so that `garrysmod/addons/artery_editor/README.txt` and `garrysmod/addons/zones/README.md` are both valid files. +4. Launch garry's mod (Re-launch if you had it up before) and select the "artery" gamemode, start a server ***with 2 players*** and open console to look for errors. + + +Next tutorial: @{tut010_first_addon.md} |
