Skip to content

Commit

Permalink
Reformulate setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
miniduikboot committed Apr 23, 2021
1 parent 8982066 commit 7f92c25
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# Boot.Codes

## What does it do?
Boot.Codes is an Impostor plugin that reads lists of 4 or 6 character long words, and will assign them to lobbies when they are created. Once the lists are exhausted, game codes will be assigned "randomly", as usual.

This Impostor plugin reads lists of 6 or 4 character long words, and will assign them to lobbies when they are created. Once the lists are exhausted, game codes will be assigned "randomly", as usual.
The advantage of this is that you have more recognizable names for your games, which makes it easier to communicate codes to others.

## 2. How to use it?
## Installation

### Prerequisites
To install the plugin, you need [Impostor](https://github.com/Impostor/Impostor) 1.4 build 178 or newer, which can be obtained from AppVeyor.

​ To install the plugin, you need [Impostor](https://github.com/Impostor/Impostor) 1.4 build 178 or newer, which can be obtained from AppVeyor. Then, you need a list of game codes. You may write your own, or you could download one of the wordlists provided in the repository. Keep in mind that codes can only be 4 or 6 characters in length.
You can now install the plugin. Just download `Boot.Codes.dll` from the [Github Releases](https://github.com/miniduikboot/Boot.Codes/releases) and put it in your `plugins` folder.

​ Wordlists may include comments with a prefix of `--`. Lines starting with the sequence will be ignored, but lines with codes may contain comments, as long as the game code precedes the comment.
To make the plugin useful you need a list of game codes. You may write your own, or you could download one of the wordlists provided in [our repository](https://github.com/miniduikboot/Boot.Codes-lists).

​ The wordlist(s) must be put in the server's directory, in a folder called `Boot.Codes`. The full path is printed out when starting. We're providing compatible wordlists with common English words in https://github.com/miniduikboot/Boot.Codes-lists
When writing your own word lists, keep in mind that codes can only be 4 or 6 characters in length and only contain letters from A up to and including Z.
​Wordlists may include comments with a prefix of `--`. Lines starting with the sequence will be ignored, but lines with codes may contain comments, as long as the game code precedes the comment.

​ After you have a compatible Impostor server, and at least one wordlist, you may download the latest release and add the DLL to the `plugins` folder.
The wordlist(s) must be put in the server's directory in a folder called `Boot.Codes`. The full path is printed out when starting Impostor with the plugin installed.

### Usage

Once you have correctly installed it, you should see a message in the console when the server is starting, showing how many codes were loaded. If you see a message indicating that no codes were loaded, your wordlists are invalid. You may also see messages warning you of invalid codes.
Once you have correctly installed it, you should see a message in the console when the server is starting, showing how many codes were loaded. If you see a message indicating that no codes were loaded, your wordlists are invalid. You may also see messages warning you of invalid codes.

If any codes were loaded, every new lobby will take a code from the lists randomly. Though, you can only have as many custom lobbies as you have words. Once there are more lobbies than the number of codes, normal codes will start being assigned again.
If any codes were loaded, every new lobby will take a code from the lists randomly. Though, you can only have as many custom lobbies as you have words. Once there are more lobbies than the number of codes, normal codes will start being assigned again.

## Showcase

Expand Down

0 comments on commit 7f92c25

Please sign in to comment.