diff options
| -rw-r--r-- | README.md | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4393ba --- /dev/null +++ b/README.md @@ -0,0 +1,95 @@ +# Winter Survival 2 - Anarchy + +## Overview +This is a gamemode for Garry's Mod, built upon the original by TheMaw. +This version has a bunch of new items, entities, and gameplay changes. The big ones include: +* NPCs that wander around that you may hunt for food +* A rudimentary magic crafting system +* Useability improvements +* Some restrictions on building have been removed +* Weapon rebalanceing + +## Install +To use this gamemode, you must have [Gearfox](cogarr.net/source/cgi.bin/gearfox) installed. +In order to have players recognized as admins, you must add them to `garrysmod/settings/users.txt` like so: +``` +"admin" +{ + "Apickx" "STEAM_0:0:13641699" + "Admin 2" "<Admin 2's team id>" + : + : +} +``` +The gamemode should work with ULX or other admin mods, but I havent tested them (If you do, I would love to hear about it!). Additionally, WS2A has it's own admin interface built in. + +## Usage: +### For server admins: +A breif list of console commands that admins can use + +`mas_goto string_playername` +Teleports you to another player + +`mas_sethp string_playername number_health` +Sets a player's health (0-100) + +`mas_bring string_playername` +Teleports another player to you + +`mas_god string_playername` +Enables godmode for a player, they will not take dammage and cannot die + +`mas_ungod string_playername` +Disables godmode for a player + +`mas_bansteamid string_steamid number_time string_reason` +Bans a player for the ammount of time. If the time is 0, the player will be banned permenently. When the player tries to join, they will be rejected with a popup: + You are banned:string_reason +on their screen + +`mas_unbansteamid string_steamid` +Unbans the given steamid + +`mas_printbannedplayers` +Prints all banned players to the console + +`mas_banplayer string_playername` +Bans a player with the given playename. Uses the player's name to lookup their steamID and uses the method above. If a player has a namechanger use `mas_bansteamid` instead. You can find a player's steam id with `status` + +## For developers +### Overview +#### Items +All items are located in gamemode/itemsystem/items you can find an example item in base.lua +#### NPC's +These might work if the developers ever stop fucking around with nextbot bindings... Some npc's are in gamemode/npcsystem/npcs, again a base npc is located in base.lua +#### Console commands +WS2A does some things in an unusual way, here are some console commands that can facilitate testing. + +`ws_cleanup` +Cleans up winter survival entities as if a round had ended + +`ws_giveitem string_playername string_itemname number_number` +Gives a certain ammount of an item to a player. If the item name has a space in it you should encapsulate it in quotes +Exmaple: `ws_giveitem Apickx "Crystal Hammer" 1` + +`ws_startnavgen` +Starts generating the navigation mesh used by nextbots. The [Valve Wiki](https://developer.valvesoftware.com/wiki/Navigation_Meshes) has more information about editing nav meshes. You can double check your nav mesh by useing `nav_edit 1` in single player. From my very breif experience, you don't really want your npcs: +* Under water +* On top of mountains +* Thinking they can walk through rocks/trees/other props +* Thinking they can walk up steep cliffs + +`ws_revive string_playername` +Revives a player from crow-ness + +`ws_proprain` +Manually trigger the proprain that happens at the beginning of each round + +`ws_reloaditems` +Because of how items are loaded in Winter Survival 2, code does not reload when saved. Use this command to reload so you don't have to restart he server every time you change an item + +`ws_reloadnpcs` +Same as above, but for npcs instead of items + +`ws_generaterecipes` +Generates a cheetsheet in HTML for you! The file is saved in garrysmod/data |