You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 15, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,25 +8,28 @@
8
8
9
9
A JavaScript wrapper over SourceMod.
10
10
11
-
[SourceMod](https://www.sourcemod.net/) is a modification to Source servers, such as Team Fortress 2 and Counter-Strike: Global Offensive. SourceMod allows you to write plugins that modify the game in all sorts of ways, while SourceMod.JS lets you write plugins or custom server logic in JavaScript (instead of SourcePawn, the complicated language SourceMod uses), then interface with a SourceMod server via WebSockets.
11
+
[SourceMod](https://www.sourcemod.net/) by itself is a modification to Source servers, such as Team Fortress 2 and Counter-Strike: Global Offensive. It allows you to write plugins that modify the game in all sorts of ways, from new gamemodes, to simple administration plugins. SourceMod.JS is a wrapper over SourceMod that lets you write plugins or custom server logic in JavaScript.
12
+
13
+
The JavaScript side (where you write your code) interfaces with an actual SourceMod server (where you install the plugin), via [WebSockets](https://en.wikipedia.org/wiki/WebSocket). This effectively allows you to wirelessly control a server over the internet, but it is heavily recommended to host the SourceMod.JS plugin on the same machine (or network) as the actual SourceMod server, to reduce latency.
@@ -46,6 +49,8 @@ Currently, the only supported and tested game server is Team Fortress 2. If you'
46
49
47
50
Other than that, feel free to contribute! Bugfixes, new features, or just better code in general are all greatly appreciated!
48
51
52
+
If you need help at any point, please feel free to contact me! You can find all of my links at [https://infinixi.us](https://infinixi.us), and my Discord is **infinixius#5875**. You can also ask for help on the [issues](https://github.com/Infinixius/sourcemod.js/issues) page.
53
+
49
54
# License
50
55
51
56
This project is under the [MIT License](https://mit-license.org/). This allows you to use, modify, and distribute the source code as long as you include the license.
@@ -57,4 +62,6 @@ This project also makes use of the following libraries and/or projects:
0 commit comments