2019-01-11 23:41:19 -05:00
# Stevenarella
2022-02-19 19:26:17 -05:00
[](https://github.com/iceiix/stevenarella/actions/workflows/build.yaml)
2019-01-11 23:41:19 -05:00
2020-10-09 22:31:40 -04:00
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
2016-04-01 15:06:24 -04:00
2016-03-31 17:20:10 -04:00
In action: http://gfycat.com/NeedyElaborateGypsymoth
2020-12-20 19:21:02 -05:00
## Community
2019-03-02 10:04:12 -05:00
2021-06-15 16:01:02 -04:00
IRC channel: `#stevenarella` on [irc.esper.net ](https://esper.net ).
2020-12-20 19:21:02 -05:00
Discussion forum: [https://github.com/iceiix/stevenarella/discussions ](https://github.com/iceiix/stevenarella/discussions ).
2019-03-02 10:04:12 -05:00
2019-01-11 23:41:19 -05:00
## Protocol support
| Game version | Protocol version | Supported? |
| ------ | --- | --- |
2022-08-06 20:35:55 -04:00
| 1.18.2 | 758 | ✓ |
2022-08-06 19:32:40 -04:00
| 1.18.1 | 757 | ✓ |
2021-09-05 16:30:32 -04:00
| 1.17.1 | 756 | ✓ |
2021-01-17 20:13:23 -05:00
| 1.16.5 | 754 | ✓ |
2020-11-24 13:30:30 -05:00
| 1.16.4 | 754 | ✓ |
| 1.16.3 | 753 | ✓ |
| 1.16.2 | 751 | ✓ |
1.16.1 protocol support (736) (#345)
* Update shifted packet ids
* Add new smithing recipe type
* Also support 1.16 (735), same packets as 1.16.1 (736)
New packets:
* GenerateStructure
New packet variants:
* UseEntity_Sneakflag, split from UseEntity_Hand
* ClientAbilities_u8, split from ClientAbilities_f32
* UpdateJigsawBlock_Joint, split from UpdateJigsawBlock_Type
* ServerMessage_Sender, split from ServerMessage_Position
* ChunkData_Biomes3D_bool, split from ChunkData_Biomes3D
* JoinGame_WorldNames, split from JoinGame_HashedSeed_Respawn
* Respawn_WorldName, split from Respawn_Gamemode
* EntityEquipment_VarInt renamed
* UpdateLight_WithTrust, split from UpdateLight_NoTrust
* LoginSuccess_UUID, split from LoginSuccess_String
2020-06-27 21:39:59 -04:00
| 1.16.1 | 736 | ✓ |
| 1.16 | 735 | ✓ |
2020-06-27 17:44:22 -04:00
| 1.15.2 | 578 | ✓ |
2019-12-29 18:55:19 -05:00
| 1.15.1 | 575 | ✓ |
2019-08-11 20:26:20 -04:00
| 1.14.4 | 498 | ✓ |
2019-07-07 17:58:49 -04:00
| 1.14.3 | 490 | ✓ |
2019-05-29 11:22:45 -04:00
| 1.14.2 | 485 | ✓ |
2019-05-13 19:44:31 -04:00
| 1.14.1 | 480 | ✓ |
2019-05-04 19:01:28 -04:00
| 1.14 | 477 | ✓ |
2019-01-11 23:41:19 -05:00
| 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 | ✓ |
2019-05-13 19:44:31 -04:00
| 1.7.10 | 5 | ✓ |
2019-01-11 23:41:19 -05:00
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.
2021-01-23 16:47:30 -05:00
Forge servers are supported on 1.7.10 - 1.12.2 (FML) and 1.13.2 - 1.16.5 (FML2).
2019-05-13 19:44:31 -04:00
2019-01-11 23:41:19 -05:00
Support for older protocols will _not_ be dropped as newer protocols are added.
2016-03-31 17:20:10 -04:00
2018-11-18 11:11:23 -05:00
## Downloads
2020-07-05 15:14:37 -04:00
Windows, Ubuntu Linux, and macOS users can download pre-compiled builds
from [GitHub Actions ](https://actions-badge.atrox.dev/iceiix/stevenarella/goto?ref=master ).
(Click the artifacts drop-down and select your platform.)
2018-11-18 11:11:23 -05:00
2020-10-09 22:31:40 -04:00
## Dependencies
2022-10-30 18:31:24 -04:00
Requires Rust stable version 1.64.0 or newer.
2020-10-09 22:31:40 -04:00
**Debian/Ubuntu**
```bash
2020-10-09 22:32:52 -04:00
sudo apt-get install libxcb1-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxcb-composite0-dev
2020-10-09 22:31:40 -04:00
```
2016-03-31 17:20:10 -04:00
2020-10-09 22:31:40 -04:00
**Alpine Linux**
```bash
sudo apk add openssl-dev xcb-util-dev
```
## Building
2016-03-31 17:20:10 -04:00
2018-11-18 11:11:23 -05: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
2019-01-11 23:41:19 -05:00
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.
2019-01-11 23:41:19 -05:00
2020-06-20 19:47:25 -04:00
## Contributions
Stevenarella is an [OPEN Open Source Project ](https://github.com/openopensource/openopensource.github.io ):
> Individuals making significant and valuable contributions are given
> commit-access to the project to contribute as they see fit. This project
> is more like an open wiki than a standard guarded open source project.
### Rules
There are a few basic ground-rules for contributors:
1. **No `--force` pushes** or modifying the Git history on the `master` branch.
1. **Non-master branches** ought to be used for ongoing work.
1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
2020-06-21 15:17:24 -04:00
1. Contributors should attempt to adhere to the prevailing code-style. Please install and run [cargo fmt ](https://github.com/rust-lang/rustfmt ) before merging any changes.
2020-06-20 19:47:25 -04:00
### Changes to this arrangement
This is an experiment and feedback is welcome! This document may also be
subject to pull-requests or changes by contributors where you believe
you have something valuable to add or change.
### 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.
### License
2019-01-11 23:41:19 -05:00
Dual-licensed MIT and ApacheV2
