Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shark-vil/background-citizens


https://github.com/shark-vil/background-citizens

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# Background NPCs

[![gLua](https://img.shields.io/badge/Language-gLua-blue.svg)](https://wiki.facepunch.com/gmod)
[![Workshop Subscribers](https://img.shields.io/badge/Workshop-Over_50000_sub.-green.svg)](https://steamcommunity.com/sharedfiles/filedetails/?id=2341497926)
[![Favorite](https://img.shields.io/badge/Favorite-Over_5000_fav.-1abc9c.svg)](https://steamcommunity.com/sharedfiles/filedetails/?id=2341497926)
![Open source](https://img.shields.io/badge/Open_source-yes-brightgreen.svg)
[![Documentation](https://img.shields.io/badge/Documentation-In_developing-yellow.svg)](https://background-npcs.itpony.ru/wiki)

## WARNING
**BE SURE TO SUBSCRIBE TO THE LIBRARY SLibrary:**
* **[SLibrary in workshop](https://steamcommunity.com/workshop/filedetails/?id=2404080563)**
* **[SLibrary in GitHub](https://github.com/Shark-vil/slib-garrysmod)**

## General
***
### **Short information**
This is an addon that will automatically spawn NPCs on the map at predetermined movement points. NPCs can walk around the map, perform random actions, attack or defend.

### **Performance**
The addon is quite optimized and almost does not generate lags. NPCs are removed when they disappear from the player's field of view, and appear with a certain delay. The spawn process is performed between server frames, which does not create unnecessary lags.

### **Assignment**
This addon can rather be considered a base for development. There is basic functionality here, but if you are a developer, you can fairly easily extend the system to suit your conditions and for any gamemode.

## Documentation
***
### **Warning**
The wiki is currently under development and some methods may not be described. When the wiki is complete, this warning will be removed.

**[Documentation](https://shark-vil.github.io/background-citizens)**

## Community