thisjaiden / socktile

Other
0 stars 0 forks source link

socktile

An unfinished game.

Running

Dev builds are avalable by going to Github Actions and downloading build artifacts for your platform.

Building

Make sure you have Rust installed.
Clone the project, and run cargo build --release in the root directory. (Builds without the --release flag are extremely slow.)
You can run a local gameserver by running the output executable with server as an argument.

Quick Builds

build_quick_test.bat / build_quck_test.sh are provided to quickly run a local game and server. build_wasm_test.sh is avalable to try experimental WASM support, which runs a local game on [http://localhost:4000]. Some library installation may be required to get WASM fully working. There is no Windows script for this test. build_ios_test.sh is avalable to try experimental iOS support. iOS support is not 100% confirmed and probably poor.

Code Layout & Docs

License

License information can be found in LICENSE.md for all original code in this repository.

socktile uses:

Name Purpose License
Twemoji Icons and placeholder textures CC-BY 4.0
Rust Programming language Apache 2.0 / MIT
Trunk WASM building MIT
Bevy Game engine MIT
bevy_asset_loader Boilerplate extension for Bevy MIT
bevy_embeded_assets Embedding extension for Bevy [MIT]()
bevy_kira_audio Kira extension for Bevy MIT
bevy_prototype_debug_lines Debugging extension for Bevy MIT
bevy_easings Animation extension for Bevy [MIT]()
serde Data serialization library MIT
serde_json JSON Extension for serde MIT
bincode Data serialization library MIT
anyhow Error propagation MIT
ldtk_rust LDtk file support MIT
tracing Backtrace handling MIT
tracing-wasm WASM extension for tracing MIT
tracing-subscriber Utility extension for tracing MIT
tracing-log Terminal extension for tracing MIT
rand Random number generation MIT
num Generic number types MIT
netty Networking Owner

All sublibraries of the above may have their own licenses which should all fall under fair use or be otherwise accounted for.