Carapace Readme

To build and run the Carapace-using mk48.io:

1. Clone this repo
2. cd into the repo
3. Run "git submodule init"
4. Run "git submodule update"
5. Remove the line: “pub mod allowlisted”, and the feature: “return_position_impl_trait_in_trait”, from secret_structs/src/lib.rs
6. Delete the file: secret_structs/src/allowlisted.rs
7. Comment out the line: “unsafe { libc::atexit(print_timing_c); }” in secret_structs/src/lib.rs
8. Run "rustup override set nightly-2022-08-14"
9. Run "rustup target add wasm32-unknown-unknown"
10. Run "cargo install --locked [email protected]"
11. cd into "client"
12. At this point, you need to install an additional system-specific component, named something similar to "nightly-2022-08-14-x86_64-unknown-linux-gnu". The specific package depends on your computer's architecture, but running "make" inside the "client" directory should give an error message that tells you the specific command required to install that package.
13. After installing the component, run "make" inside the "client" directory.
14. cd into "../server"
15. Run "make"
16. Navigate to localhost:8081 (or whatever port is printed in the console)

All changes to the application code are marked with a comment beginning: Carapce. Additional comments explaining or noting particular changes we made are marked with a comment beginning: Carapce-details

Carapace Update Notes

The reason for steps 5-7 above is that Mk48.io relies on an older version of Rust, which does not allow impl blocks to contain function definitions of the form "fn a(...) -> impl ... {...}". This form of function definition is required for methods using the dot operator to be used inside of secure blocks.

If Mk48.io is updated to a later version of Rust, a few minor changes need to be made, the largest of which is replacing the obsolete "into_ok_or_err()" with a more modern equivalent. In some way that seems unrelated to these changes, running Mk48.io after updating to a later version of Rust results in the following error: Upgrading to certain types of ships causes the game to freeze, turn completely blue, and refuse to respond to any further input from the player. The simplest demonstration of this issue is to run the game in debug mode, and then click the option to upgrade to a Level 10 Ship, located at the top of the screen. This immediately causes the error. The same error occurs in release mode with what seems to be the same ship upgrades.

Mk48.io Game

Mk48.io is an online multiplayer naval combat game, in which you take command of a ship and sail your way to victory. Watch out for torpedoes!

• Ship Suggestions

Building

Tools

0. Install rustup (see instructions here)
1. Install Rust Nightly (rustup override set nightly-2022-08-14)
2. Add WebAssembly target (rustup target add wasm32-unknown-unknown)
3. Install trunk (cargo install --locked trunk, install gcc first if it complains about missing cc)
4. Optionally, install the make command

You may use any version of Rust that works, but only nightly-2022-08-14 is known to be compatible.

Client

0. Enter /client
1. make or, equivalently, trunk build --release
2. Deploy the server to host the client

Server

0. Enter /server
1. make to build and run a test server
2. Navigate to localhost:8081 (or whatever port is printed in the console)

Developing

If you follow the Building steps, you have a fully functioning game (could be used to host a private server). If your goal is to modify the game, you may want to read more :)

Entity data

Entities (ships, weapons, aircraft, collectibles, obstacles, decoys, etc.) are defined at the bottom of common/src/entity/_type.rs.

Entity textures

Each entity type must be accompanied by a texture of the same name in the spritesheet, which comes with the repository. If entity textures need to be changed, see instructions in the sprite_sheet_packer directory.

Engine

Both client and server rely on our custom game engine (which is present in the engine directory).

Admin interface (optional)

One notable feature of the engine is an (optional) admin interface. To build it:

0. Install NodeJS 14 or higher (here)
1. Enter /engine/js
2. make
3. Deploy the server to host the admin interface
4. Go to localhost:8081/admin/
5. Paste the contents of engine/game_server/src/auth.txt, generated randomly by a build script, into the alert dialog

Macros

Many macros are utilized by the codebase. Mk48-specific macros can be found in the macros directory, and game engine macros can be found in the engine/engine_macros directory. A few notable macros are:

• Mk48 entity loader (generates EntityData for all entity types, used by both client and server)
• Game engine audio loader (generates Audio enum for client, with a variant per sound)
• Game engine settings (generates Javascript bindings for settings structs)
• Game engine renderer layer (for composable rendering layers)

Contributing

See Contributing Wiki page.

Trademark

Mk48.io is a trademark of Softbear, Inc.