aboutsummaryrefslogtreecommitdiff
path: root/doc/examples/setup.md
blob: 2f9e0cee7f907a9e2720c1b80913c00128a7a3db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Tut 0x00 Setup & 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