0.1.0

Author: corybear

.gitignore

@@ -6,4 +6,4 @@ terrain.png
 *.data.old
 *.swp
 serde-test/*
-.ssh/*
+.ssh/*

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "engine"]
+	path = engine
+	url = [email protected]:softbeargames/kodiak.git

Makefile

@@ -0,0 +1,8 @@
+include makefiles/game.mk
+
+server_perf_record:
+	cargo build --manifest-path server/Cargo.toml
+	sudo perf record --call-graph=dwarf ./server/target/release/server
+
+server_perf_report:
+	sudo perf report --hierarchy -f -M intel

README.md

@@ -11,30 +11,33 @@
 
 - [Ship Suggestions](https://github.com/SoftbearStudios/mk48/discussions/132)
 
-## Building
+## Build Instructions
 
-### Tools
+1. Install `rustup` ([see instructions here](https://rustup.rs/))
+2. Install `gmake` and `gcc` if they are not already installed.
+3. Install `trunk` (`cargo install --locked trunk --version 0.17.5`)
+4. Run `download_makefiles.sh`
+5. Install Rust Nightly and the WebAssembly target
 
-0. Install `rustup` ([see instructions here](https://rustup.rs/))
-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
+```console
+make rustup
+```
 
-You may use any version of Rust that works, but only `nightly-2022-08-14` is known
-to be compatible.
+6. Build client
 
-### Client
+```console
+cd client
+make release
+```
 
-0. Enter `/client`
-1. `make` or, equivalently, `trunk build --release`
-2. Deploy the server to host the client
+7. Build and run server
 
-### Server
+```console
+cd server
+make run_release
+```
 
-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)
+8. Navigate to `https://localhost:8443/` and play!
 
 ## Developing
 
@@ -51,29 +54,6 @@ Entities (ships, weapons, aircraft, collectibles, obstacles, decoys, etc.) are d
 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](https://nodejs.org/en/download/))
-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](https://github.com/SoftbearStudios/mk48/wiki/Contributing) Wiki page.