Skip to content
This repository was archived by the owner on Jan 15, 2024. It is now read-only.

Commit 0e7f303

Browse files
InfinixiusInfinixius
committed
Update docs
1 parent 71d1cf2 commit 0e7f303

17 files changed

+729
-499
lines changed

‎README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
A JavaScript wrapper over SourceMod.
88

9+
[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. SourceMod.JS lets you write plugins or custom server logic in JavaScript, then interface with a SourceMod server via WebSockets.
10+
911
# Installation
1012
```
1113
npm install sourcemod.js
@@ -28,6 +30,8 @@ You can also run the console command `smjs_test`:
2830
[SMJS] Test!
2931
```
3032

33+
While the connection via WebSockets technically allows you to remotely control a SourceMod server, it's ideal to have the server and the SourceMod.JS plugin running on the same computer (or network) to minimize latency.
34+
3135
# Examples
3236

3337
```js
@@ -52,7 +56,7 @@ server.on("ready", async () => {
5256
// infinixius disconnected!
5357
```
5458

55-
Documentation is available at [https://infinixi.us/sourcemod.js](https://infinixi.us/sourcemod.js).
59+
Documentation is available at [https://sourcemod.js.org/](https://sourcemod.js.org/).
5660

5761
# Contributing
5862

‎docs/Console.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>Console - Documentation</title>
6+
<title>Console - SourceMod.JS Documentation</title>
77

8+
<meta name="description" content="A JavaScript wrapper over SourceMod." />
9+
10+
<meta name="keywords" content="sourcemod, sourcemod.js" />
11+
<meta name="keyword" content="sourcemod, sourcemod.js" />
12+
13+
14+
15+
<meta property="og:title" content="SourceMod.JS Documentation"/>
16+
<meta property="og:type" content="website"/>
17+
<meta property="og:image" content="https://sourcemod.js.org/assets/socialpreview.png"/>
18+
<meta property="og:site_name" content="SourceMod.JS Documentation"/>
19+
<meta property="og:url" content="https://sourcemod.js.org"/>
820

921
<script src="scripts/prettify/prettify.js"></script>
1022
<script src="scripts/prettify/lang-css.js"></script>
@@ -567,7 +579,7 @@ <h5>Parameters:</h5>
567579
<br class="clear">
568580

569581
<footer>
570-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Feb 14 2022 20:40:22 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
582+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Wed Feb 16 2022 17:02:50 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
571583
</footer>
572584

573585
<script>prettyPrint();</script>

‎docs/Console.js.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>Console.js - Documentation</title>
6+
<title>Console.js - SourceMod.JS Documentation</title>
77

8+
<meta name="description" content="A JavaScript wrapper over SourceMod." />
9+
10+
<meta name="keywords" content="sourcemod, sourcemod.js" />
11+
<meta name="keyword" content="sourcemod, sourcemod.js" />
12+
13+
14+
15+
<meta property="og:title" content="SourceMod.JS Documentation"/>
16+
<meta property="og:type" content="website"/>
17+
<meta property="og:image" content="https://sourcemod.js.org/assets/socialpreview.png"/>
18+
<meta property="og:site_name" content="SourceMod.JS Documentation"/>
19+
<meta property="og:url" content="https://sourcemod.js.org"/>
820

921
<script src="scripts/prettify/prettify.js"></script>
1022
<script src="scripts/prettify/lang-css.js"></script>
@@ -101,7 +113,7 @@ <h1 class="page-title">Console.js</h1>
101113
<br class="clear">
102114

103115
<footer>
104-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Feb 14 2022 20:40:22 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
116+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Wed Feb 16 2022 17:02:50 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
105117
</footer>
106118

107119
<script>prettyPrint();</script>

‎docs/Player.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>Player - Documentation</title>
6+
<title>Player - SourceMod.JS Documentation</title>
77

8+
<meta name="description" content="A JavaScript wrapper over SourceMod." />
9+
10+
<meta name="keywords" content="sourcemod, sourcemod.js" />
11+
<meta name="keyword" content="sourcemod, sourcemod.js" />
12+
13+
14+
15+
<meta property="og:title" content="SourceMod.JS Documentation"/>
16+
<meta property="og:type" content="website"/>
17+
<meta property="og:image" content="https://sourcemod.js.org/assets/socialpreview.png"/>
18+
<meta property="og:site_name" content="SourceMod.JS Documentation"/>
19+
<meta property="og:url" content="https://sourcemod.js.org"/>
820

921
<script src="scripts/prettify/prettify.js"></script>
1022
<script src="scripts/prettify/lang-css.js"></script>
@@ -1074,7 +1086,7 @@ <h5>Parameters:</h5>
10741086
<br class="clear">
10751087

10761088
<footer>
1077-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Feb 14 2022 20:40:22 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1089+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Wed Feb 16 2022 17:02:50 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
10781090
</footer>
10791091

10801092
<script>prettyPrint();</script>

‎docs/Player.js.html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,20 @@
33
<head>
44

55
<meta charset="utf-8">
6-
<title>Player.js - Documentation</title>
6+
<title>Player.js - SourceMod.JS Documentation</title>
77

8+
<meta name="description" content="A JavaScript wrapper over SourceMod." />
9+
10+
<meta name="keywords" content="sourcemod, sourcemod.js" />
11+
<meta name="keyword" content="sourcemod, sourcemod.js" />
12+
13+
14+
15+
<meta property="og:title" content="SourceMod.JS Documentation"/>
16+
<meta property="og:type" content="website"/>
17+
<meta property="og:image" content="https://sourcemod.js.org/assets/socialpreview.png"/>
18+
<meta property="og:site_name" content="SourceMod.JS Documentation"/>
19+
<meta property="og:url" content="https://sourcemod.js.org"/>
820

921
<script src="scripts/prettify/prettify.js"></script>
1022
<script src="scripts/prettify/lang-css.js"></script>
@@ -148,7 +160,7 @@ <h1 class="page-title">Player.js</h1>
148160
<br class="clear">
149161

150162
<footer>
151-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Mon Feb 14 2022 20:40:22 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
163+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a> on Wed Feb 16 2022 17:02:50 GMT-0500 (Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
152164
</footer>
153165

154166
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)