mirror of
https://github.com/lexi-lambda/shattered-plans.git
synced 2024-11-25 07:48:04 +03:00
51 lines
2.9 KiB
Markdown
51 lines
2.9 KiB
Markdown
|
# Shattered Plans
|
|||
|
|
|
|||
|
|
Shattered Plans is a turn-based strategy game by [Jagex Ltd.][jagex] It was originally released in 2008 as part of [FunOrb][], which was sadly shut down in 2018 without any successor. This repository is a fan project that restores Shattered Plans to a playable state. Based on a decompiled archive of the original Shattered Plans client, it includes a reimplementation of the original FunOrb server, which makes Shattered Plans playable again in both singleplayer and multiplayer modes.
|
|||
|
|
|
|||
|
|
[![Screenshot of Shattered Plans gameplay.][screenshot.png]][screenshot.png]
|
|||
|
|
|
|||
|
|
## Running the game
|
|||
|
|
|
|||
|
|
Running Shattered Plans requires [Java 17 or newer][download-java] and the latest version of the game JAR. You can then run the game by running the following command:
|
|||
|
|
|
|||
|
|
```sh
|
|||
|
|
java -jar shattered-plans-0.0.5.jar --local-server
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
As the name suggests, passing the `--local-server` flag will run a Shattered Plans server locally, allowing you to play the game in singleplayer mode. Other players can connect to your server by running
|
|||
|
|
|
|||
|
|
```sh
|
|||
|
|
java -jar shattered-plans-0.0.5.jar --host <HOST>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
replacing `<HOST>` with your IP address. By default, the server runs on port 43594, but you can specify a different port using the `--port` flag. A few other options are also available, pass `--help` to see them all.
|
|||
|
|
|
|||
|
|
## What works, what doesn’t, and other limitations
|
|||
|
|
|
|||
|
|
All singleplayer functionality should work flawlessly. Most multiplayer functionality works as well. However, there are some bugs, unimplemented features, and other limitations:
|
|||
|
|
|
|||
|
|
* When you start the game, you will be presented with a login screen. You may enter any username/password combination you like, and the server will not check it. In fact, attempting to create an account will not work: the server does not record any persistent user state.
|
|||
|
|
|
|||
|
|
* Lobby and in-game chat are supported, but adding users to your friends or ignore list is not, so there is no way to send private messages.
|
|||
|
|
|
|||
|
|
* Resigning is implemented, but offering a draw or a rematch is not currently supported.
|
|||
|
|
|
|||
|
|
* Rated games are not implemented.
|
|||
|
|
|
|||
|
|
* Achievements are not implemented.
|
|||
|
|
|
|||
|
|
* There may be bugs in the server protocol, which can lead to disconnects or desyncs. Please report any bugs you come across, providing as much information as possible, and I will do my best to fix them.
|
|||
|
|
|
|||
|
|
There are also some very minor improvements over the original game, but these will most likely not even be noticeable to most players.
|
|||
|
|
|
|||
|
|
## Community
|
|||
|
|
|
|||
|
|
If you’d like to find people to play with, or if you have any questions, [join the FunOrb discord server!][funorb-discord] This is obviously a small hobby project, so I cannot guarantee my time, but I’ll do my best to be helpful.
|
|||
|
|
|
|||
|
|
[screenshot.png]: docs/screenshot.png
|
|||
|
|
|
|||
|
|
[download-java]: https://www.oracle.com/java/technologies/downloads/
|
|||
|
|
[FunOrb]: https://en.wikipedia.org/wiki/FunOrb
|
|||
|
|
[funorb-discord]: https://discord.gg/MGfDrDf
|
|||
|
|
[jagex]: https://www.jagex.com/
|