aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a532f6372e7b2b390adb1d61db8362381e5a4ae8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Artery RPG base

Artery is a gamemode base for Garrys Mod that aims to provide a lot of the functionality needed to build an RPG. Artery is organized as a set of modules that each provide one functionality, and an editor that provides an easy-to-use interface for setting up worlds.

Artery can:

* Stich several servers together to create a single logical world
* Save and load player data
* Spawn npcs that wander around, give quests, provides shops, and more!
* Easily work with external NPC addons so you don't have to make all the stuff to kill yourself
* Allow for extensible addons to change basic parts of artery, or just add on to the base

##Dependencies

As of now, artery depends on the following addons:

* bobbleheadbob's zone tool
* CapsAdmin's PAC3 (+JetBoom's animbonelib which comes packaged with PAC3)
* artery_editor

## Installation

To install, simple clone this repository into the gamemodes/ folder of the server. Start the server with `+gamemode artery`

## Setup

In order to build your world, you will probably need to write a lot of your own items, and a few npcs. This is much easier with the artery_editor addon, and GCompute. Just start the server with the sandbox gamemode.

* To add npcs, go under the entities tab, and go to the "artery" section.
* To add randomly spawning monsters, place art_huntablespawn points around the map, and then create zones with bobbleheadbob's Zones tool. Configure the zone with the monsters, and chance of spawning you want.
* To add new items, see the items tutorial on [the documentation](https://cogarr.net/artery/)
* To stich servers together into a logical world, use the zones tool to place art_serverchagne volumes, configure the volume with the server to go to (ipaddress:port) and the location on the server to spawn the player.