Skip to content

Commit

Permalink
add Discord server link to readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tombez committed Oct 14, 2021
1 parent 75409a6 commit e685a68
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
# MultiOgarII
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/).


# Details
This section is a brief documentation of the server for those interested in using it.

##### ***This is still being written.***


## Quick Start
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.

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.
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.

```BASH
# install modules
Expand All @@ -23,21 +16,26 @@ $ cd src
# start server
$ node index.js
```

## Questions / Modifications
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)
Do not create a GitHub issue for a question.

### Commands
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.
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.

### Gamemodes
The server offers a small set of gamemodes, these include:
- Free For All
- Free For All
- Experimental
- Teams
- Rainbow

All the gamemodes are standard, asides from rainbow.
All the gamemodes are standard, aside from rainbow.


## Protocols
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.

## TLS
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).
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 comments on commit e685a68

Please sign in to comment.