summaryrefslogtreecommitdiff
path: root/ws2a/help.html
blob: abcdf5456601f4a94793db722e54fbed129fdfc5 (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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>WS2A - help</title>

    <link href="../css/milligram.min.css" rel="stylesheet">
	<link href="style.css" rel="stylesheet">
    
    <link href="./help.css" rel="stylesheet">

  </head>

  <body>
	<main class="wrapper">
	<section class="container">
        	<h1 class="title">Winter Survival 2 - Extended</h1>
		<ul class="row">
			<li class="column"><a href="#for-owners">For Server Owners</a></li>
			<li class="column"><a href="#for-admins">For Server Admins</a></li>
			<li class="column"><a href="#for-devs">For Developers</a></li>
		</ul>
	</section>
      <section class="container" id="for-owners">
        <h2 class="title">For Server Owners</h2>
        <p>You can download Winter Survival 2 either useing git (recommended) by installing <a href="https://www.git-scm.com/">git</a> on your server, and executing
        <p><pre>
cd C:/path/to/server/garrysmod/gamemodes/
git clone https://cogarr.net/source/cgit.cgi/wintersurvival2.git
git clone https://cogarr.net/source/cgit.cgi/gearfox.git/</pre>
        <p>or by downloading <a href="http://cogarr.net/source/cgit.cgi/gearfox.git/">gearfox</a> and <a href="http://cogarr.net/source/cgit.cgi/wintersurvival2.git/"> Winter survival 2 </a> and dropping both into your /gamemode/ directory.
        <p>To intall, simply drop the wintersurvival2 folder into the /gamemodes/ folder of your server, located at /garrysmod/gamemodes/. Then, add the folowing line to /garrysmod/cfg/server.cfg
        <p><pre>gamemode wintersurvival2</pre>
        <p>The gamemode should be able to use admin mods like ULX, but they haven't been tested. In addition, Winter Survival 2 - Extended comes with it's own admin system, see "For Server Admins" below
        <p>Admins must be added by adding the name/steamid to the garrysmod/settings/users.txt file like so
        <pre>
"admin"
{
  "Apickx"                                "STEAM_0:0:13641699"
}
        </pre>
      </section>
      <section class="container" id="for-admins">
        <h2 class="title">For Server Admins</h2>
        <h5>This is a breif list of admin commands that can be used.</h5>
        <br/><code>mas_goto string_playername</code><br/>
        Teleports you to another player<br/>
        <br/><code>mas_sethp string_playername number_health</code><br/>
        Sets a players health<br/>
        <br/><code>mas_bring string_playername</code><br/>
        Teleports another player to you<br/>
        <br/><code>mas_god string_playername</code><br/>
        Enables godmode for a player, they will not take dammage, and cannot die.<br/>
        <br/><code>mas_ungod string_playername</code><br/>
        Disables godmode for a player<br/>
        <br/><code>mas_bansteamid string_steamid number_time string_reason</code><br/>
        Bans a player for an ammount of time. If the time is 0, this will ban the player permenently. When the player tries to join, they will get a popup with "You are banned:string_reason" on their screen.<br/>
        <br/><code>mas_unbansteamid string_steamid</code><br/>
        Unbans the given steamid.<br/>
        <br/><code>mas_printbannedplayers</code><br/>
        Prints all banned players to console<br/>
        <br/><code>mas_banplayer string_playername</code><br/>
        Bans a player with the given playername. Translates the player's name to their steamid. If a player has a name changer, use mas_bansteamid instead. You can find a player's steamid with <code>status</code><br/>
        </pre></code><br/>
      </section>

      <section class="container" id="for-devs">
          <h2 class="title">For Developers</h2>
          <h5>Stuff about how to add to this gamemode</h5>
          <h3>Items</h3>
          <p>All items are located in gamemode/itemsystem/items, you can find an example item in base.lua
          <h3>NPC's</h3>
          <p>If garry ever stops fucking around with the nextbot bindings, some npcs are in gamemode/npcsystem/npcs, again a base npc is located in base.lua
          <h3>Utility</h3>
          <p>In addition, there are some console commands made especially for developers<br/>
          <br/><code>ws_cleanup</code><br/>
          <p>Cleans up all the winter survival specific entities on the server<br/>
          <br/><code>ws_giveitem string_playername string_itemname number_number</code><br/>
          <p>Gives a certain ammount of items to a player. If the item name has a space in it, you should encapsulate it in quotes "Crystal Hammer"<br/>
          <br/><code>ws_startnavgen</code><br/>
          <p>Starts generateing the navigation mesh used by nextbots. The <a href="https://developer.valvesoftware.com/wiki/Navigation_Meshes"> Valve Wiki</a> has more about editing nav meshes. You can double-check your nav mesh by useing <code>nav_edit 1</code> in single player. From my very breif experience, you don't really want your npcs:
          <ul>
              <li>Under water
              <li>On top of mountains
              <li>Thinking they can walk through rocks
              <li>Thinking they can walk up steep clifs
          </ul>
          <br/><code>ws_revive string_playername</code><br/>
          <p>Revies a player from pidgeon-ness<br/>
          <br/><code>ws_proprain</code><br/>
          <p>Manually generate the prop rain that falls at the beginning if each round<br/>
          <br/><code>ws_reloaditems</code><br/>
          <p>Because of how items are loaded in Winter Survival 2, code dosen't reload how you expected to when you edit a file and save it. Use this command to reload so you don't have to restart the server.<br/>
          <br/><code>ws_reloadnpcs</code><br/>
          <p>Same as above, for npcs<br/>
          <br/><code>ws_generaterecipes</code><br/>
          <p>Generates a cheetsheet in HTML for you! the file is saved in garrysmod/data<br/>
          <br/><code>ws_generaterecipes</code><br/>
          <p>Generates a cheetsheet in HTML for you! the file is saved in garrysmod/data<br/>

      </section>


    </main> 

  </body>
</html>