Awesome Open Source
Awesome Open Source

Grid Plugin

An UE4 plugin for grid-based game

https://github.com/jinyuliao/Grid/blob/master/docs/images/grid.png?raw=true

Features

  • Support square and hexagon grid
  • Support multi-level grid
  • Grid-based pathfinding and movement
  • Multiple grid rendering method: Decal and Outline(XCom2-like)
  • Grid sensing component [1]
  • Blueprint support
  • Editor integration
  • Customizable classes
  • PathGuide for rendering path

QuickStart

  • Set pawn's default controller to AAIController or its subclass [2]
  • Add UGridNavigationComponent to your pawn [3]
  • Add UGridSensingComponent to your pawn (optional)
  • Spawn GridManager at game startup [4]
  • Write game logic

Customizable Classes

  • UGridInfo: inherit from this class to add game-specific information
  • USquarePathFinder and UHexagonPathFinder: customize pathfinding logic
  • UGridNavigationAgent: inherit from this class to implement special movement, e.g.: jump, climb and so on
  • UGridPainter: customize grid rendering [5]

Install

  1. Clone this project to ${YourProject}/Plugins/
  2. Generate project file
  3. Compile

Donate

Donate
[1] plus a component visualizer for debug and level design
[2] we need it to implement default grid-based movement
[3] if you have custom UGridNavigationAgent, add it to Component's 'AgentClasses'
[4] if you have custom class, set it properly in spawn parameter
[5] Default is UGridDecalPainter which using decal component to rendering grid


Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
C Plus Plus (238,550
Plugin (113,900
Video Game (82,612
Grid (12,489
Rendering (8,347
Unreal Engine (2,254
Pathfinding (1,223
Ue4 (776