Skip to content

Add installation instructions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TyGrze wants to merge 2 commits into
base: master
Choose a base branch
from
+11 −2
Open

Add installation instructions #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79ab92a
Add installation instructions
TyGrze Aug 12, 2026
8e03ed3
Update repository name in installation instructions
TyGrze Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `SplitScreenSample` (with submodules: `git submodule update --init --recursive`)

2. Run `SplitScreenSample.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,
Expand All @@ -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

Expand Down