stevenarella/README.md

92 lines
2.5 KiB
Markdown
Raw Normal View History

# Stevenarella
[![builds.sr.ht status](https://builds.sr.ht/~iceiix/stevenarella.svg)](https://builds.sr.ht/~iceiix/stevenarella?)
Multi-protocol Minecraft-compatible client written in Rust
2016-03-31 17:20:10 -04:00
Don't expect it to go anywhere, just doing this for fun.
## Images
2016-04-21 07:01:20 -04:00
![Steven on Hypixel](https://i.imgur.com/PM5fLuu.png)
2016-04-01 15:06:24 -04:00
![Steven](https://i.imgur.com/RRspOQF.png)
2016-03-31 17:20:10 -04:00
In action: http://gfycat.com/NeedyElaborateGypsymoth
2019-03-02 10:04:12 -05:00
## Community chatroom
We have a chatroom on [EsperNet](https://esper.net): `irc.esper.net` server, `#stevenarella` channel.
Join with your favorite IRC client or [Matrix](https://matrix.to/#/#_espernet_#stevenarella:matrix.org).
## Protocol support
| Game version | Protocol version | Supported? |
| ------ | --- | --- |
| 1.14.4 | 498 | ✓ |
| 1.14.3 | 490 | ✓ |
| 1.14.2 | 485 | ✓ |
| 1.14.1 | 480 | ✓ |
| 1.14 | 477 | ✓ |
| 19w02a | 452 | ✓ |
| 18w50a | 451 | ✓ |
| 1.13.2 | 404 | ✓ |
| 1.12.2 | 340 | ✓ |
| 1.11.2 | 316 | ✓ |
| 1.11 | 315 | ✓ |
| 1.10.2 | 210 | ✓ |
| 1.9.2 | 109 | ✓ |
| 1.9 | 107 | ✓ |
| 15w39c | 74 | ✓ |
| 1.8.9 | 47 | ✓ |
| 1.7.10 | 5 | ✓ |
Stevenarella is designed to support multiple protocol versions, so that client
development is not in lock-step with the server version. The level of
support varies, but the goal is to support major versions from 1.7.10
up to the current latest major version. Occasionally, snapshots are also supported.
Forge servers are currently supported on 1.7.10 - 1.12.2.
Support for older protocols will _not_ be dropped as newer protocols are added.
2016-03-31 17:20:10 -04:00
## Credits
Thanks to [@thinkofname](https://github.com/thinkofname/) for
the original [Steven (Rust)](https://github.com/thinkofname/steven),
which Stevenarella is an updated and enhanced version of.
2016-03-31 17:20:10 -04:00
## Downloads
Windows users can download pre-compiled builds from here: https://ci.appveyor.com/project/iceiix/stevenarella
(Select your platform, Click the artifacts tab and download Steven.zip)
The Visual Studio 2017 Redistributable is required to run these builds.
2016-03-31 17:20:10 -04:00
## Building
2019-05-05 09:22:31 -04:00
Requires Rust stable version 1.34.1 or newer to build.
2016-03-31 17:20:10 -04:00
Compile and run:
```bash
cargo run --release
```
Just compile:
```bash
cargo build --release
```
2016-03-31 17:20:10 -04:00
Add support for compiling WebAssembly wasm32-unknown-unknown target (#92) Note this only is the first step in web support, although the project compiles, it doesn't run! Merging now to avoid branch divergence, until dependencies can be updated for wasm support. * Add instructions to build for wasm32-unknown-unknown with wasm-pack in www/ * Update to rust-clipboard fork to compile with emscripten https://github.com/aweinstock314/rust-clipboard/pull/62 * Exclude reqwest dependency in wasm32 * Exclude compiling clipboard pasting on wasm32 * Exclude reqwest-using code from wasm32 * Install wasm target with rustup in Travis CI * Update to collision 0.19.0 Fixes wasm incompatibility in deprecated rustc-serialize crate: https://github.com/rustgd/collision-rs/issues/106 error[E0046]: not all trait items implemented, missing: `encode` --> github.com-1ecc6299db9ec823/rustc-serialize-0.3.24/src/serialize.rs:1358:1 * Increase travis_wait time even further, try 120 minutes * Set RUST_BACKTRACE=1 in main * Remove unused unneeded bzip2 features in zip crate To fix wasm32-unknown-unknown target compile error: error[E0432]: unresolved imports `libc::c_int`, `libc::c_uint`, `libc::c_void`, `libc::c_char` --> src/github.com-1ecc6299db9ec823/bzip2-sys-0.1.7/lib.rs:5:12 | 5 | use libc::{c_int, c_uint, c_void, c_char}; | ^^^^^ ^^^^^^ ^^^^^^ ^^^^^^ no `c_char` in the root | | | | | | | no `c_void` in the root | | no `c_uint` in the root | no `c_int` in the root * flate2 use Rust backend * Add console_error_panic_hook module for wasm backtraces * Build using wasm-pack, wasm-bindgen, run with wasm-app * Update to miniz_oxide 0.2.1, remove patch for https://github.com/Frommi/miniz_oxide/issues/42 * Update to official clipboard crate since https://github.com/aweinstock314/rust-clipboard/pull/62 was merged, but git revision pending release * Update to branch of glutin attempting to build for wasm https://github.com/iceiix/glutin/pull/1 * Update winit dependency of glutin to git master https://github.com/iceiix/winit/pull/2 * Update to glutin branch with working (compiles, doesn't run) wasm_stub * Add app name in title on web page * Add wasm to Travis-CI test matrix * Update glutin to fix Windows EGL compilation on AppVeyor https://github.com/iceiix/glutin/pull/1/commits/97797352b5242436cb82d8ecfb44242b69766e4c
2019-03-03 11:32:36 -05:00
For progress on web support, see [www/](./www).
2016-03-31 17:20:10 -04:00
## Running
### Standalone
Just running Stevenarella via a double click (Windows) or `./stevenarella` (everything else)
2016-03-31 17:20:10 -04:00
will bring up a login screen followed by a server list which you can select a server
from.
## License
Dual-licensed MIT and ApacheV2