Skip to content
This repository has been archived by the owner on Sep 18, 2021. It is now read-only.

Commit

Permalink
Update the readme to be more descriptive
Browse files Browse the repository at this point in the history
  • Loading branch information
hmadison committed Dec 10, 2017
1 parent 13ad59a commit 4c7b220
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions README.md
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/)

0 comments on commit 4c7b220

Please sign in to comment.