Release v0.4.0

feather-rs · Sep 1, 2019 · 4aa8be2 · 4aa8be2
1 parent f79547e
commit 4aa8be2
Show file tree

Hide file tree

Showing 15 changed files with 72 additions and 98 deletions.
diff --git a/.azure-pipelines.yml b/.azure-pipelines.yml
@@ -141,15 +141,15 @@ jobs:
         displayName: Copy assets
         inputs:
           sourceFolder: '$(Build.SourcesDirectory)/target/release'
-          contents: feather_server
+          contents: feather-server
           targetFolder: '$(Build.BinariesDirectory)/feather'
         condition: ne( variables['Agent.OS'], 'Windows_NT' )
 
       - task: CopyFiles@2
         displayName: Copy assets
         inputs:
           sourceFolder: '$(Build.SourcesDirectory)\target\release'
-          contents: feather_server.exe
+          contents: feather-server.exe
           targetFolder: '$(Build.BinariesDirectory)\feather'
         condition: eq( variables['Agent.OS'], 'Windows_NT' )
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -7,8 +7,6 @@ members = [
     "items",
     "item_block",
     "codegen",
-    "client/core",
-    "client/wrapper/console",
     "generator",
     "util/rand-legacy",
 ]
diff --git a/README.md b/README.md
@@ -16,19 +16,28 @@ Many basic features are already implemented:
 - [x] Inventory handling
 - [x] Movement broadcasting
 
-Obviously, key features are missing. However, development is currently
-quite active, and features should be added at a fast pace over the next few months.
+Development is currently quite active, and features should be added at a fast pace over the next few months.
 
 ### Running
-If you want to try out the software, you currently have to compile Feather yourself.
-
-Run ```cargo build --release``` in the repository's root directory to compile the code. To start the server,
-you will have to do the following:
-- Move the binary ```target/release/feather_server``` to your desired server directory.
-- Copy a **1.13.2** Minecraft world save to the server directory, under the directory name "world."
+We offer precompiled binaries for Windows and Linux at [GitHub Releases](https://github.com/caelunshun/feather/releases).
+
+To run Feather:
+* Extract the downloaded archive.
+* Move a 1.13.2 Minecraft world save to the directory you extracted the archive to. Name the world save "world."
+* Run the binary.
+  * On Linux and macOS: `./feather_server` in the server directory
+  * On Windows: double-click `feather_server.exe`
+
+The server will create a configuration file (`feather.toml`) which you can modify.
 
-Then, simply run the binary: ```./feather_server```.
+Feather currently only supports 1.13.2 clients and world saves. In the future, additional versions will be supported.
 
-The server will create a configuration file (`feather.toml`) which you can modify.
+### Compiling
+If you are on another platform, compile the server yourself to try it out:
+```bash
+git clone https://github.com/caelunshun/feather
+cd feather
+cargo build --release
+```
 
-The server currently only supports 1.13.2 clients and world saves. In the future, additional versions will be supported.
+The server executable will be located in `target/release`.
diff --git a/blocks/Cargo.toml b/blocks/Cargo.toml
@@ -1,11 +1,11 @@
 [package]
-name = "feather_blocks"
-version = "0.3.0"
+name = "feather-blocks"
+version = "0.4.0"
 authors = ["caelunshun <caelunshun@gmail.com>"]
 edition = "2018"
 
 [dependencies]
-feather_codegen = { path = "../codegen" }
+feather-codegen = { path = "../codegen" }
 lazy_static = "1.4.0"
 byteorder = "1.3.2"
 failure = "0.1.5"

diff --git a/client/core/Cargo.toml b/client/core/Cargo.toml
diff --git a/client/core/src/lib.rs b/client/core/src/lib.rs
diff --git a/client/wrapper/console/Cargo.toml b/client/wrapper/console/Cargo.toml
diff --git a/client/wrapper/console/src/main.rs b/client/wrapper/console/src/main.rs
diff --git a/codegen/Cargo.toml b/codegen/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "feather_codegen"
-version = "0.3.0"
+name = "feather-codegen"
+version = "0.4.0"
 authors = ["caelunshun <caelunshun@gmail.com>"]
 edition = "2018"
 

diff --git a/core/Cargo.toml b/core/Cargo.toml
@@ -1,14 +1,14 @@
 [package]
-name = "feather_core"
-version = "0.3.0"
+name = "feather-core"
+version = "0.4.0"
 authors = ["caelunshun <caelunshun@gmail.com>"]
 edition = "2018"
 publish = false
 
 [dependencies]
-feather_codegen = { path = "../codegen" }
-feather_blocks = { path = "../blocks" }
-feather_items = { path = "../items" }
+feather-codegen = { path = "../codegen" }
+feather-blocks = { path = "../blocks" }
+feather-items = { path = "../items" }
 lazy_static = "1.4.0"
 derive-new = "0.5.8"
 uuid = "0.7.4"

diff --git a/generator/Cargo.toml b/generator/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "feather_generator"
-version = "0.3.0"
+name = "feather-generator"
+version = "0.4.0"
 authors = ["caelunshun <caelunshun@gmail.com>"]
 edition = "2018"
 description = "Code generators for Feather"

diff --git a/item_block/Cargo.toml b/item_block/Cargo.toml
@@ -1,11 +1,11 @@
 [package]
-name = "feather_item_block"
-version = "0.1.0"
+name = "feather-item-block"
+version = "0.4.0"
 authors = ["caelunshun <caelum12321@gmail.com>"]
 edition = "2018"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-feather_blocks = { path = "../blocks" }
-feather_items = { path = "../items" }
+feather-blocks = { path = "../blocks" }
+feather-items = { path = "../items" }
diff --git a/items/Cargo.toml b/items/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "feather_items"
-version = "0.1.0"
+name = "feather-items"
+version = "0.4.0"
 authors = ["caelunshun <caelunshun@gmail.com>"]
 edition = "2018"
 

diff --git a/server/Cargo.toml b/server/Cargo.toml
@@ -1,13 +1,12 @@
 [package]
-name = "feather_server"
-version = "0.3.0"
+name = "feather-server"
+version = "0.4.0"
 authors = ["caelunshun <caelunshun@gmail.com>"]
 edition = "2018"
-publish = false
 
 [dependencies]
-feather_core = { path = "../core" }
-feather_item_block = { path = "../item_block" }
+feather-core = { path = "../core" }
+feather-item-block = { path = "../item_block" }
 mio = "0.6.19"
 mio-extras = "2.0.5"
 crossbeam = "0.7.2"
@@ -45,7 +44,7 @@ nalgebra-glm = "0.4.2"
 nalgebra = "0.18.1"
 ncollide3d = "0.20.1"
 derive_deref = "1.1.0"
-feather_codegen = { path = "../codegen" }
+feather-codegen = { path = "../codegen" }
 bitflags = "1.1.0"
 fnv = "1.0.6"
 base64 = "0.10.1"