From 79ab92a79b852c4d87594abcbaf622ccc2b0aefd Mon Sep 17 00:00:00 2001 From: Tyler Gregorcyk Date: Wed, 12 Aug 2026 12:42:47 -0500 Subject: [PATCH 1/2] Add installation instructions --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b91c38..d02e0b9 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,16 @@ Simple local co-op racing game project made with [Flax Engine](https://flaxengin Project uses asses from [Kenney](https://kenney.nl/assets) (Creative Commons CC0). -### Controls + +## Installation + +0. Ensure to have proper system setup for C++ Scripting - see [Flax Docs](https://docs.flaxengine.com/manual/scripting/cpp/index.html) + +1. Clone repo `SplitScreenFramework` (with submodules: `git submodule update --init --recursive`) + +2. Run `SplitScreenFramework.flaxproj` with a minimal Flax version of `1.13.7008` + +## Controls Up to 4 local players with controls: * Player 1: `WASD` to drive, `Space` to handbrake, @@ -20,7 +29,7 @@ Each player can use gamepad: `left stick` to drive, `left trigger` to handbrake. ![Flax Split-Screen Sample](Content/split-2.gif) -### License +## License MIT License From 8e03ed3adbff2f2e698f17c4458a58a53b2a99dc Mon Sep 17 00:00:00 2001 From: Tyler Gregorcyk Date: Wed, 12 Aug 2026 12:49:12 -0500 Subject: [PATCH 2/2] Update repository name in installation instructions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d02e0b9..142e22a 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ Project uses asses from [Kenney](https://kenney.nl/assets) (Creative Commons CC0 0. Ensure to have proper system setup for C++ Scripting - see [Flax Docs](https://docs.flaxengine.com/manual/scripting/cpp/index.html) -1. Clone repo `SplitScreenFramework` (with submodules: `git submodule update --init --recursive`) +1. Clone repo `SplitScreenSample` (with submodules: `git submodule update --init --recursive`) -2. Run `SplitScreenFramework.flaxproj` with a minimal Flax version of `1.13.7008` +2. Run `SplitScreenSample.flaxproj` with a minimal Flax version of `1.13.7008` ## Controls