Cherry/3D2D-Textscreens
1
0
Fork 0
mirror of https://github.com/Cherry/3D2D-Textscreens.git synced 2025-03-04 03:13:15 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
James Ross 2019-01-26 23:03:15 +00:00 committed by GitHub
parent 7b79133b47
commit 3567788bfa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,9 +1,9 @@
[![3D2D Textscreens](https://up.jross.me/textscreens/logo-dark.png)](https://steamcommunity.com/sharedfiles/filedetails/?id=109643223)
[![Powered by Nodecraft](https://up.jross.me/textscreens/nodecraft-logo-dark.png)](https://nodecraft.com/r/textscreens)
##### This addon can be installed via the [Steam Workshop for Garry's Mod](https://steamcommunity.com/sharedfiles/filedetails/?id=109643223) - I do not recommend manually installing this addon via git.
> This addon can be installed via the [Steam Workshop for Garry's Mod](https://steamcommunity.com/sharedfiles/filedetails/?id=109643223) - I do not recommend manually installing this addon via git.
###### Features:
## Features:
* Create 3D2D text anywhere in the world
* Rotate and manipulate this text simply via your physgun
* Up to 5 lines of text
@ -18,11 +18,22 @@
* Define preset textscreen data (size, text, colours, etc) and save/load these for future use at any time. This is very useful to trying to replicate multiple textscreens across maps.
###### Server owners:
## Server owners:
* `sbox_maxtextscreens` controls the maximum amount of text screens that each player can spawn. This defaults to 1. This cvar only exists on the server, so make sure it's set via RCON, or in something like server.cfg.
* Set `ss_call_to_home 1` on your server to provide anonymous analytics including your operating system, version of the addon, and rough, anonymised geo-location. This is entirely optional and used solely to put a smile on my face.
* To install this onto your server, follow the instructions [listed here](https://wiki.garrysmod.com/page/Workshop_for_Dedicated_Servers).
### Custom admin permissions:
This addon supports custom permissions via the use of `TextscreensCanAdmin`. When this hook isn't present, or doesn't return anything, it default to an `IsSuperAdmin` check. If you want to override this behaviour for your own admin permissions, create a hook that exists both server *and* client side, similar to the following:
```lua
hook.Add("TextscreensCanAdmin", "MyCustomAdminFunc", function(ply)
return ply:SteamID() == "STEAM_0:0:43716939"
end)
```
---
Further information can be found on the [Steam Workshop for Garry's Mod](https://steamcommunity.com/sharedfiles/filedetails/?id=109643223).
All pull requests welcomed.