This repository has been archived by the owner on Sep 18, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the readme to be more descriptive
- Loading branch information
Showing
1 changed file
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,35 @@ | ||
# beam-craft | ||
by Lobsters | ||
|
||
|
||
## Introduction | ||
|
||
This is a simple Minecraft Classic server written in Elixir. | ||
This is a simple Minecraft Classic server written in Elixir. It is compatable with the [ClassicSharp client](https://github.com/UnknownShadow200/ClassicalSharp). | ||
|
||
## Running The Server | ||
|
||
```sh | ||
$ git clone https://github.com/spawnfest/beam-craft | ||
$ cd beam-craft | ||
$ mix deps.get | ||
$ mix run --no-halt | ||
``` | ||
|
||
By default the server starts on port `5555` and listens on `0.0.0.0`. | ||
|
||
## Running The Client | ||
|
||
### Windows | ||
|
||
Use the Windows release provided at the [ClassicSharp website](https://www.classicube.net/). | ||
|
||
### Mac OS X / Linux | ||
|
||
Use the Mac OS X / Linux release provided at the [ClassicSharp website](https://www.classicube.net/) under [Wine](https://www.winehq.org/). | ||
To get all of the assets first run the launcher, then invoke the client directly like `wine ClassicalSharp.exe <username> <password> <ip> <port>`. | ||
|
||
## Useful links | ||
|
||
* [Elixir's woefully hidden docs on binary munging](https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L132) | ||
|
||
* [ClassicSharp client](https://github.com/UnknownShadow200/ClassicalSharp) | ||
* [Minecraft Classic protocol](https://minecraft.gamepedia.com/Classic_server_protocol#Packet_Protocol) | ||
* [Minecraft Classic block types](https://minecraft.gamepedia.com/Java_Edition_data_values/Classic) | ||
* [Lobsters](https://lobste.rs/) |