Skip to content

Commit 2fa3f12

Browse files
committed
add Discord server link to readme.md
1 parent 75409a6 commit 2fa3f12

1 file changed

Lines changed: 10 additions & 12 deletions

File tree

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
11
# MultiOgarII
22
MultiOgarII is a FOSS agar.io server implementation that is based upon the [work done](https://github.com/Barbosik/MultiOgar) by [Barbosik](https://github.com/Barbosik/).
33

4-
5-
# Details
6-
This section is a brief documentation of the server for those interested in using it.
7-
8-
##### ***This is still being written.***
9-
10-
114
## Quick Start
125
Before the server can be used you need to install [NodeJS](https://nodejs.org/en/) (LTS version) onto your machine. Instructions for which are available on the NodeJS website linked above.
136

14-
Once this is done, the server can be ran by executing the following commands in a `Linux` terminal or a `Windows Command Prompt`. This is assuming that you're in the project directory.
7+
Once this is done, the server can be ran by executing the following commands in a `Linux` terminal or a `Windows Command Prompt`. This is assuming that you're in the project directory.
158

169
```BASH
1710
# install modules
@@ -23,21 +16,26 @@ $ cd src
2316
# start server
2417
$ node index.js
2518
```
19+
20+
### Questions / Modifications
21+
If you have a question about how to add a feature, or how to change a behavior of the game, ask for help on the [Agar.io Private Servers Discord](https://discord.gg/XcKgShT)
22+
Do not create a GitHub issue for a question.
23+
2624
### Commands
27-
Once started, the server's functionality can be altered via the use of commands. These commands can be listed, and documented, by running `help`. The command line interface allows for the generation of aliases, which shorten a command - these can be generated by running `aliases`. This command shortens all of the available commands into short abreviation/ For example, the command `killall` is shortened down to `kl` - where the last characters form the alias.
25+
Once started, the server's functionality can be altered via the use of commands. These commands can be listed, and documented, by running `help`. The command line interface allows for the generation of aliases, which shorten a command - these can be generated by running `aliases`. This command shortens all of the available commands into short abreviation/ For example, the command `killall` is shortened down to `kl` - where the last characters form the alias.
2826

2927
### Gamemodes
3028
The server offers a small set of gamemodes, these include:
31-
- Free For All
29+
- Free For All
3230
- Experimental
3331
- Teams
3432
- Rainbow
3533

36-
All the gamemodes are standard, asides from rainbow.
34+
All the gamemodes are standard, aside from rainbow.
3735

3836

3937
## Protocols
4038
This server implementation supports the majority of the early Agar protocols. This includes protocols ranging from `v4` to around `v11`. This means that clients running protocols outside of that range *may malfunction or not work at all.* It is suggested that you use a client such as [Cigar](https://github.com/Luka967/Cigar), or its [Cigar2](https://github.com/Cigar2/Cigar2) variant - both of these use protocol v6 and are compatible with the server.
4139

4240
## TLS
43-
In order to use protocols such as HTTPS with a webocket connection you need to enable TLS. This is documented in [keys/README.md](./keys/README.md).
41+
In order to use protocols such as HTTPS with a webocket connection you need to enable TLS. This is documented in [keys/README.md](./keys/README.md).

0 commit comments

Comments
 (0)