https://github.com/flaxengine/arizonaframeworksample

Sample project showcasing usage of Arizona Framework for Flax Engine
https://github.com/flaxengine/arizonaframeworksample

flax flaxengine gamedev gameplay

Last synced: about 1 month ago
JSON representation

Sample project showcasing usage of Arizona Framework for Flax Engine

• Host: GitHub
• URL: https://github.com/flaxengine/arizonaframeworksample
• Owner: FlaxEngine
• License: mit
• Created: 2023-02-09T10:05:01.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T17:02:01.000Z (2 months ago)
• Last Synced: 2024-10-20T01:25:23.211Z (2 months ago)
• Topics: flax, flaxengine, gamedev, gameplay
• Language: C#
• Homepage:
• Size: 2.41 MB
• Stars: 18
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Arizona Framework Sample

![Arizona Framework Sample](Documentation/screenshot.png)

Sample project showcasing usage of [Arizona Framework](https://github.com/FlaxEngine/ArizonaFramework) for [Flax Engine](https://flaxengine.com/).

## 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 `ArizonaFrameworkSample` (with submodules: `git submodule update --init --recursive`)

2. Run `ArizonaFrameworkSample.flaxproj`

## License

Both this sample and Arizona Framework are released under **MIT License**.

## Documentation

### Main Menu

![Main Menu](Documentation/main-menu.png)

**Menu Level** contains the game's main menu which is the first scene to be loaded on the game start. It allows specifying the server IP address and port to use for connecting or game hosting. UI handles focus navigation thus it is usable via gamepad only.

### Game Level

![Game Level](Documentation/game-level.png)

**Game Level** is a sample scene with basic lighting (sun, sky light, env probe) with enabled [volumetric fog](https://docs.flaxengine.com/manual/graphics/fog-effects/volumetric-fog.html) and [global illumination](https://docs.flaxengine.com/manual/graphics/lighting/gi/realtime.html). It uses prototype assets from Arizona Framework for level blockout.

Game Levels can be easily playtested with local game hosting (implemented in `MyGameEditor`) - simply hit *Play* button.